Globus SDK for JavaScript
    Preparing search index...
    interface paths {
        "/v2/authenticate": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: { "application/json": string };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/v2/batch_status": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: undefined;
                };
                requestBody: { content: { "application/json": { task_ids: string[] } } };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                response: string;
                                results: {
                                    [key: string]: {
                                        completion_t?: string;
                                        exception?: string;
                                        reason?: string;
                                        result?: string;
                                        status?: unknown;
                                        task_id: string;
                                    };
                                };
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/v2/containers": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            description?: string;
                            location: string;
                            name: string;
                            type: "docker"
                            | "singularity";
                        };
                    };
                };
                responses: {
                    "200": {
                        content: { "application/json": { container_id: string } };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/v2/containers/{container_uuid}/{container_type}": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { container_type: string; container_uuid: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                container: {
                                    build_status: | "provided"
                                    | "submitted"
                                    | "initialized"
                                    | "queued"
                                    | "building"
                                    | "ready"
                                    | "failed";
                                    build_stderr?: string;
                                    container_uuid: string;
                                    err_message?: string;
                                    location?: string;
                                    name: string;
                                    type?: "docker"
                                    | "singularity";
                                };
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/v2/containers/build": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            apt: string[];
                            conda: string[];
                            description?: string;
                            name: string;
                            payload_url?: string;
                            pip: string[];
                        };
                    };
                };
                responses: {
                    "200": {
                        content: { "application/json": { container_id: string } };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/v2/containers/build/{container_uuid}": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { container_uuid: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                status: | "provided"
                                | "submitted"
                                | "initialized"
                                | "queued"
                                | "building"
                                | "ready"
                                | "failed";
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/v2/endpoints": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: { role?: "owner"
                    | "any" };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                display_name: string;
                                name: string;
                                owner: string;
                                uuid: string;
                            }[];
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header: {
                        "remote-addr"?: string;
                        "user-agent": string;
                        "x-forwarded-for"?: string;
                    };
                    path?: undefined;
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            allowed_functions?: string[];
                            authentication_policy?: string;
                            display_name?: string;
                            endpoint_name: string;
                            endpoint_uuid: string;
                            metadata?: {
                                config?: Record<string, unknown>;
                                description?: string;
                                endpoint_config?: string;
                                endpoint_version?: string;
                                hostname?: string;
                                ip_address?: string;
                                local_user?: string;
                                python_version?: string;
                                sdk_version?: string;
                                user_config_schema?: Record<string, unknown>;
                                user_config_template?: string;
                            };
                            multi_user: boolean;
                            version?: string;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": | {
                                endpoint_id: string;
                                result_queue_info: {
                                    connection_url: string;
                                    exchange: string;
                                    queue: string;
                                    queue_publish_kwargs: {
                                        exchange: string;
                                        mandatory: boolean;
                                        properties: { delivery_mode: number };
                                        routing_key: string;
                                    };
                                };
                                task_queue_info: {
                                    connection_url: string;
                                    exchange: string;
                                    queue: string;
                                };
                                warnings?: string[];
                            }
                            | {
                                command_queue_info: {
                                    connection_url: string;
                                    exchange: string;
                                    queue: string;
                                };
                                endpoint_id: string;
                                warnings?: string[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/v2/endpoints/{endpoint_uuid}": {
            delete: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { endpoint_uuid: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: { "application/json": { result: number } };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { endpoint_uuid: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                config?: Record<string, unknown>;
                                description?: string;
                                display_name: string;
                                endpoint_config?: string;
                                endpoint_version?: string;
                                high_assurance: boolean;
                                hostname?: string;
                                ip_address?: string;
                                local_user?: string;
                                multi_user: boolean;
                                name: string;
                                public: boolean;
                                python_version?: string;
                                sdk_version?: string;
                                subscription_uuid?: string;
                                user_config_schema?: Record<string, unknown>;
                                user_config_template?: string;
                                uuid: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/v2/endpoints/{endpoint_uuid}/lock": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { endpoint_uuid: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                endpoint_id: string;
                                lock_expiration_timestamp: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/v2/endpoints/{endpoint_uuid}/status": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { endpoint_uuid: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                details?: {
                                    idle_workers: number;
                                    managers?: number;
                                    outstanding_tasks: number;
                                    pending_tasks: number;
                                    total_workers: number;
                                };
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/v2/functions": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header: { "user-agent": string };
                    path?: undefined;
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            container_uuid?: string;
                            description?: string;
                            entry_point?: string;
                            function_code: string;
                            function_name: string;
                            group?: string;
                            metadata?: { python_version?: string; sdk_version?: string };
                            public: boolean;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: { "application/json": { function_uuid: string } };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/v2/functions/{function_uuid}": {
            delete: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { function_uuid: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: { "application/json": { result: number } };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { function_uuid: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                description?: string;
                                function_code: string;
                                function_name?: string;
                                function_uuid: string;
                                metadata: { python_version?: string; sdk_version?: string };
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/v2/get_amqp_result_connection_url": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                connection_url: string;
                                queue_prefix: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/v2/stats": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": { total_function_invocations: number };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/v2/submit": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header: { "content-length": number };
                    path?: undefined;
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            create_websocket_queue: boolean;
                            task_group_id?: string;
                            tasks: [string, string, string][];
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                response: string;
                                results: (
                                    | string
                                    | {
                                        http_status_code: number;
                                        reason?: string;
                                        status: string;
                                        task_uuid: string;
                                    }
                                )[];
                                task_group_id?: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/v2/taskgroup/{task_group_uuid}": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { task_group_uuid: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                create_websockets_queue?: boolean;
                                taskgroup_id: string;
                                tasks: { created_at: string; id: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/v2/tasks/{task_uuid}": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { task_uuid: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                completion_t?: string;
                                details?: Record<string, unknown>;
                                exception?: string;
                                result?: string;
                                status?: unknown;
                                task_id: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/v2/version": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: { service?: "all"
                    | "api" };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": | string
                            | {
                                api: string;
                                container_service?: string;
                                git_sha?: string;
                                min_ep_version?: string;
                                min_sdk_version?: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: { service?: "all"
                    | "api" };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: { "application/json": unknown };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/v3/endpoints": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header: {
                        "remote-addr"?: string;
                        "user-agent": string;
                        "x-forwarded-for"?: string;
                    };
                    path?: undefined;
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            admins?: string[];
                            allowed_functions?: string[];
                            authentication_policy?: string;
                            display_name?: string;
                            endpoint_name: string;
                            high_assurance: boolean;
                            metadata: {
                                config?: Record<string, unknown>;
                                description?: string;
                                endpoint_config?: string;
                                endpoint_version?: string;
                                hostname?: string;
                                ip_address?: string;
                                local_user?: string;
                                python_version?: string;
                                sdk_version?: string;
                                user_config_schema?: Record<string, unknown>;
                                user_config_template?: string;
                            };
                            multi_user: boolean;
                            public: boolean;
                            subscription_uuid?: string;
                            version?: string;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": | {
                                endpoint_id: string;
                                heartbeat_queue_info: {
                                    connection_url: string;
                                    exchange: string;
                                    queue: string;
                                    queue_publish_kwargs: {
                                        exchange: string;
                                        mandatory: boolean;
                                        properties: { delivery_mode: number };
                                        routing_key: string;
                                    };
                                };
                                result_queue_info: {
                                    connection_url: string;
                                    exchange: string;
                                    queue: string;
                                    queue_publish_kwargs: {
                                        exchange: string;
                                        mandatory: boolean;
                                        properties: { delivery_mode: number };
                                        routing_key: string;
                                    };
                                };
                                task_queue_info: {
                                    connection_url: string;
                                    exchange: string;
                                    queue: string;
                                };
                                warnings?: string[];
                            }
                            | {
                                command_queue_info: {
                                    connection_url: string;
                                    exchange: string;
                                    queue: string;
                                };
                                endpoint_id: string;
                                heartbeat_queue_info: {
                                    connection_url: string;
                                    exchange: string;
                                    queue: string;
                                    queue_publish_kwargs: {
                                        exchange: string;
                                        mandatory: boolean;
                                        properties: { delivery_mode: number };
                                        routing_key: string;
                                    };
                                };
                                result_queue_info: {
                                    connection_url: string;
                                    exchange: string;
                                    queue: string;
                                    queue_publish_kwargs: {
                                        exchange: string;
                                        mandatory: boolean;
                                        properties: { delivery_mode: number };
                                        routing_key: string;
                                    };
                                };
                                warnings?: string[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: { loc: (string | number)[]; msg: string; type: string }[];
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "423": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/v3/endpoints/{endpoint_uuid}": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put: {
                parameters: {
                    cookie?: undefined;
                    header: {
                        "remote-addr"?: string;
                        "user-agent": string;
                        "x-forwarded-for"?: string;
                    };
                    path: { endpoint_uuid: string };
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            admins?: string[];
                            allowed_functions?: string[];
                            authentication_policy?: string;
                            display_name?: string;
                            endpoint_name: string;
                            high_assurance: boolean;
                            metadata: {
                                config?: Record<string, unknown>;
                                description?: string;
                                endpoint_config?: string;
                                endpoint_version?: string;
                                hostname?: string;
                                ip_address?: string;
                                local_user?: string;
                                python_version?: string;
                                sdk_version?: string;
                                user_config_schema?: Record<string, unknown>;
                                user_config_template?: string;
                            };
                            multi_user: boolean;
                            public: boolean;
                            subscription_uuid?: string;
                            version?: string;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": | {
                                endpoint_id: string;
                                heartbeat_queue_info: {
                                    connection_url: string;
                                    exchange: string;
                                    queue: string;
                                    queue_publish_kwargs: {
                                        exchange: string;
                                        mandatory: boolean;
                                        properties: { delivery_mode: number };
                                        routing_key: string;
                                    };
                                };
                                result_queue_info: {
                                    connection_url: string;
                                    exchange: string;
                                    queue: string;
                                    queue_publish_kwargs: {
                                        exchange: string;
                                        mandatory: boolean;
                                        properties: { delivery_mode: number };
                                        routing_key: string;
                                    };
                                };
                                task_queue_info: {
                                    connection_url: string;
                                    exchange: string;
                                    queue: string;
                                };
                                warnings?: string[];
                            }
                            | {
                                command_queue_info: {
                                    connection_url: string;
                                    exchange: string;
                                    queue: string;
                                };
                                endpoint_id: string;
                                heartbeat_queue_info: {
                                    connection_url: string;
                                    exchange: string;
                                    queue: string;
                                    queue_publish_kwargs: {
                                        exchange: string;
                                        mandatory: boolean;
                                        properties: { delivery_mode: number };
                                        routing_key: string;
                                    };
                                };
                                result_queue_info: {
                                    connection_url: string;
                                    exchange: string;
                                    queue: string;
                                    queue_publish_kwargs: {
                                        exchange: string;
                                        mandatory: boolean;
                                        properties: { delivery_mode: number };
                                        routing_key: string;
                                    };
                                };
                                warnings?: string[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "409": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: { loc: (string | number)[]; msg: string; type: string }[];
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "423": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            trace?: undefined;
        };
        "/v3/endpoints/{endpoint_uuid}/allowed_functions": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { endpoint_uuid: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                endpoint_id: string;
                                functions?: string[];
                                restricted: boolean;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/v3/endpoints/{endpoint_uuid}/console": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { endpoint_uuid: string };
                    query?: { include_fields?: string; user_endpoint_id?: string };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                user_endpoints: {
                                    account?: string;
                                    active: boolean;
                                    client_sdk_versions?: string[];
                                    config?: string;
                                    endpoint_version?: string;
                                    engine_type?: string;
                                    executed_task_count?: number;
                                    idle_worker_count?: number;
                                    last_heartbeat_unix?: number;
                                    node_info?: { [key: string]: (...)[] };
                                    posix_pid?: number;
                                    posix_username?: string;
                                    provider_type?: string;
                                    python_version?: string;
                                    queue?: string;
                                    queued_task_count?: number;
                                    running_task_count?: number;
                                    start_time_iso?: string;
                                    start_time_unix?: number;
                                    total_node_count?: number;
                                    total_worker_count?: number;
                                    user_endpoint_id: string;
                                }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: { loc: (string | number)[]; msg: string; type: string }[];
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/v3/endpoints/{endpoint_uuid}/lock": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { endpoint_uuid: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                endpoint_id: string;
                                lock_expiration_timestamp: number;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: { loc: (string | number)[]; msg: string; type: string }[];
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/v3/endpoints/{endpoint_uuid}/submit": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header: { "content-length": number; "user-agent": string };
                    path: { endpoint_uuid: string };
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            create_queue: boolean;
                            resource_specification?: {
                                launcher_options?: string;
                                num_nodes: number;
                                num_ranks?: number;
                                ranks_per_node?: number;
                            };
                            result_serializers?: string[];
                            task_group_id?: string;
                            tasks: { [key: string]: string[] };
                            user_endpoint_config?: Record<string, unknown>;
                            user_runtime?: {
                                globus_compute_sdk_version?: string;
                                globus_sdk_version?: string;
                                python_version?: string;
                            };
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                endpoint_id: string;
                                request_id: string;
                                task_group_id: string;
                                tasks: { [key: string]: string[] };
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "403": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "413": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: { loc: (string | number)[]; msg: string; type: string }[];
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/v3/functions": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            description?: string;
                            function_code: string;
                            function_name: string;
                            group?: string;
                            ha_endpoint_id?: string;
                            meta: {
                                python_version: string;
                                sdk_version: string;
                                serde_identifier: string;
                            };
                            public: boolean;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: { "application/json": { function_uuid: string } };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "413": {
                        content: {
                            "application/json": {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": | {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: string;
                                status: string;
                            }
                            | {
                                code: string;
                                error_args: unknown[];
                                http_status_code: number;
                                reason: { loc: ((...) | (...))[]; msg: string; type: string }[];
                                status: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
    }
    Index

    Properties

    "/v2/authenticate": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: { "application/json": string };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: { "application/json": string };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Check Authentication

      Check if the user is authenticated.

      • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: { "application/json": string };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: { "application/json": string };
              headers: { [name: string]: unknown };
          }

          Successful Response

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v2/batch_status": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: { content: { "application/json": { task_ids: string[] } } };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            response: string;
                            results: {
                                [key: string]: {
                                    completion_t?: string;
                                    exception?: string;
                                    reason?: string;
                                    result?: string;
                                    status?: unknown;
                                    task_id: string;
                                };
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: undefined;
          };
          requestBody: { content: { "application/json": { task_ids: string[] } } };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          response: string;
                          results: {
                              [key: string]: {
                                  completion_t?: string;
                                  exception?: string;
                                  reason?: string;
                                  result?: string;
                                  status?: unknown;
                                  task_id: string;
                              };
                          };
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get Batch Status

      Get the status of one or more tasks.

      The body of a request contains a list one or more task IDs; the response
      will contain a dictionary of objects with a set of relevant data for
      each passed ID.
      
      • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
      • requestBody: { content: { "application/json": { task_ids: string[] } } }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        response: string;
                        results: {
                            [key: string]: {
                                completion_t?: string;
                                exception?: string;
                                reason?: string;
                                result?: string;
                                status?: unknown;
                                task_id: string;
                            };
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      response: string;
                      results: {
                          [key: string]: {
                              completion_t?: string;
                              exception?: string;
                              reason?: string;
                              result?: string;
                              status?: unknown;
                              task_id: string;
                          };
                      };
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

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

          Validation Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v2/containers": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        description?: string;
                        location: string;
                        name: string;
                        type: "docker"
                        | "singularity";
                    };
                };
            };
            responses: {
                "200": {
                    content: { "application/json": { container_id: string } };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      description?: string;
                      location: string;
                      name: string;
                      type: "docker"
                      | "singularity";
                  };
              };
          };
          responses: {
              "200": {
                  content: { "application/json": { container_id: string } };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Register Container

      Register a new container

      • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
      • requestBody: {
            content: {
                "application/json": {
                    description?: string;
                    location: string;
                    name: string;
                    type: "docker" | "singularity";
                };
            };
        }
      • responses: {
            "200": {
                content: { "application/json": { container_id: string } };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: { "application/json": { container_id: string } };
              headers: { [name: string]: unknown };
          }

          Successful Response

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

          Validation Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v2/containers/{container_uuid}/{container_type}": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { container_type: string; container_uuid: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            container: {
                                build_status: | "provided"
                                | "submitted"
                                | "initialized"
                                | "queued"
                                | "building"
                                | "ready"
                                | "failed";
                                build_stderr?: string;
                                container_uuid: string;
                                err_message?: string;
                                location?: string;
                                name: string;
                                type?: "docker"
                                | "singularity";
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { container_type: string; container_uuid: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          container: {
                              build_status: | "provided"
                              | "submitted"
                              | "initialized"
                              | "queued"
                              | "building"
                              | "ready"
                              | "failed";
                              build_stderr?: string;
                              container_uuid: string;
                              err_message?: string;
                              location?: string;
                              name: string;
                              type?: "docker"
                              | "singularity";
                          };
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get Container Status

      Get the details of a container

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { container_type: string; container_uuid: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { container_type: string; container_uuid: string }
          • container_type: string

            Type of containers to return (Docker, Singularity)

          • container_uuid: string

            Container UUID

        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        container: {
                            build_status:
                                | "provided"
                                | "submitted"
                                | "initialized"
                                | "queued"
                                | "building"
                                | "ready"
                                | "failed";
                            build_stderr?: string;
                            container_uuid: string;
                            err_message?: string;
                            location?: string;
                            name: string;
                            type?: "docker"
                            | "singularity";
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      container: {
                          build_status:
                              | "provided"
                              | "submitted"
                              | "initialized"
                              | "queued"
                              | "building"
                              | "ready"
                              | "failed";
                          build_stderr?: string;
                          container_uuid: string;
                          err_message?: string;
                          location?: string;
                          name: string;
                          type?: "docker"
                          | "singularity";
                      };
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

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

          Validation Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v2/containers/build": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        apt: string[];
                        conda: string[];
                        description?: string;
                        name: string;
                        payload_url?: string;
                        pip: string[];
                    };
                };
            };
            responses: {
                "200": {
                    content: { "application/json": { container_id: string } };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      apt: string[];
                      conda: string[];
                      description?: string;
                      name: string;
                      payload_url?: string;
                      pip: string[];
                  };
              };
          };
          responses: {
              "200": {
                  content: { "application/json": { container_id: string } };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Build Container

      Build a new container

      • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
      • requestBody: {
            content: {
                "application/json": {
                    apt: string[];
                    conda: string[];
                    description?: string;
                    name: string;
                    payload_url?: string;
                    pip: string[];
                };
            };
        }
      • responses: {
            "200": {
                content: { "application/json": { container_id: string } };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: { "application/json": { container_id: string } };
              headers: { [name: string]: unknown };
          }

          Successful Response

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

          Validation Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v2/containers/build/{container_uuid}": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { container_uuid: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            status: | "provided"
                            | "submitted"
                            | "initialized"
                            | "queued"
                            | "building"
                            | "ready"
                            | "failed";
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { container_uuid: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          status: | "provided"
                          | "submitted"
                          | "initialized"
                          | "queued"
                          | "building"
                          | "ready"
                          | "failed";
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get Container Build Status

      Get the status of a container build

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { container_uuid: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { container_uuid: string }
          • container_uuid: string

            Container UUID

        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        status:
                            | "provided"
                            | "submitted"
                            | "initialized"
                            | "queued"
                            | "building"
                            | "ready"
                            | "failed";
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      status:
                          | "provided"
                          | "submitted"
                          | "initialized"
                          | "queued"
                          | "building"
                          | "ready"
                          | "failed";
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

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

          Validation Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v2/endpoints": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: { role?: "owner" | "any" };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            display_name: string;
                            name: string;
                            owner: string;
                            uuid: string;
                        }[];
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header: {
                    "remote-addr"?: string;
                    "user-agent": string;
                    "x-forwarded-for"?: string;
                };
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        allowed_functions?: string[];
                        authentication_policy?: string;
                        display_name?: string;
                        endpoint_name: string;
                        endpoint_uuid: string;
                        metadata?: {
                            config?: Record<string, unknown>;
                            description?: string;
                            endpoint_config?: string;
                            endpoint_version?: string;
                            hostname?: string;
                            ip_address?: string;
                            local_user?: string;
                            python_version?: string;
                            sdk_version?: string;
                            user_config_schema?: Record<string, unknown>;
                            user_config_template?: string;
                        };
                        multi_user: boolean;
                        version?: string;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": | {
                            endpoint_id: string;
                            result_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                                queue_publish_kwargs: {
                                    exchange: string;
                                    mandatory: boolean;
                                    properties: { delivery_mode: number };
                                    routing_key: string;
                                };
                            };
                            task_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                            };
                            warnings?: string[];
                        }
                        | {
                            command_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                            };
                            endpoint_id: string;
                            warnings?: string[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: { role?: "owner" | "any" };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          display_name: string;
                          name: string;
                          owner: string;
                          uuid: string;
                      }[];
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get Endpoints

      Get a list of endpoints associated with the authenticated user.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { role?: "owner" | "any" };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • Optionalpath?: undefined
        • Optionalquery?: { role?: "owner" | "any" }
          • Optionalrole?: "owner" | "any"

            Role of user in relation to desired endpoints

      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        display_name: string;
                        name: string;
                        owner: string;
                        uuid: string;
                    }[];
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      display_name: string;
                      name: string;
                      owner: string;
                      uuid: string;
                  }[];
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

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

          Validation Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header: {
                  "remote-addr"?: string;
                  "user-agent": string;
                  "x-forwarded-for"?: string;
              };
              path?: undefined;
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      allowed_functions?: string[];
                      authentication_policy?: string;
                      display_name?: string;
                      endpoint_name: string;
                      endpoint_uuid: string;
                      metadata?: {
                          config?: Record<string, unknown>;
                          description?: string;
                          endpoint_config?: string;
                          endpoint_version?: string;
                          hostname?: string;
                          ip_address?: string;
                          local_user?: string;
                          python_version?: string;
                          sdk_version?: string;
                          user_config_schema?: Record<string, unknown>;
                          user_config_template?: string;
                      };
                      multi_user: boolean;
                      version?: string;
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": | {
                          endpoint_id: string;
                          result_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                              queue_publish_kwargs: {
                                  exchange: string;
                                  mandatory: boolean;
                                  properties: { delivery_mode: number };
                                  routing_key: string;
                              };
                          };
                          task_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                          };
                          warnings?: string[];
                      }
                      | {
                          command_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                          };
                          endpoint_id: string;
                          warnings?: string[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Register Endpoint

      Register an endpoint by associating it with the authenticated user and saving it to the database.

      • parameters: {
            cookie?: undefined;
            header: {
                "remote-addr"?: string;
                "user-agent": string;
                "x-forwarded-for"?: string;
            };
            path?: undefined;
            query?: undefined;
        }
      • requestBody: {
            content: {
                "application/json": {
                    allowed_functions?: string[];
                    authentication_policy?: string;
                    display_name?: string;
                    endpoint_name: string;
                    endpoint_uuid: string;
                    metadata?: {
                        config?: Record<string, unknown>;
                        description?: string;
                        endpoint_config?: string;
                        endpoint_version?: string;
                        hostname?: string;
                        ip_address?: string;
                        local_user?: string;
                        python_version?: string;
                        sdk_version?: string;
                        user_config_schema?: Record<string, unknown>;
                        user_config_template?: string;
                    };
                    multi_user: boolean;
                    version?: string;
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json":
                        | {
                            endpoint_id: string;
                            result_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                                queue_publish_kwargs: {
                                    exchange: string;
                                    mandatory: boolean;
                                    properties: { delivery_mode: number };
                                    routing_key: string;
                                };
                            };
                            task_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                            };
                            warnings?: string[];
                        }
                        | {
                            command_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                            };
                            endpoint_id: string;
                            warnings?: string[];
                        };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json":
                      | {
                          endpoint_id: string;
                          result_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                              queue_publish_kwargs: {
                                  exchange: string;
                                  mandatory: boolean;
                                  properties: { delivery_mode: number };
                                  routing_key: string;
                              };
                          };
                          task_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                          };
                          warnings?: string[];
                      }
                      | {
                          command_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                          };
                          endpoint_id: string;
                          warnings?: string[];
                      };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

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

          Validation Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v2/endpoints/{endpoint_uuid}": {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { endpoint_uuid: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: { "application/json": { result: number } };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { endpoint_uuid: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            config?: Record<string, unknown>;
                            description?: string;
                            display_name: string;
                            endpoint_config?: string;
                            endpoint_version?: string;
                            high_assurance: boolean;
                            hostname?: string;
                            ip_address?: string;
                            local_user?: string;
                            multi_user: boolean;
                            name: string;
                            public: boolean;
                            python_version?: string;
                            sdk_version?: string;
                            subscription_uuid?: string;
                            user_config_schema?: Record<string, unknown>;
                            user_config_template?: string;
                            uuid: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • delete: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { endpoint_uuid: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: { "application/json": { result: number } };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Delete Endpoint

      Delete the endpoint.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { endpoint_uuid: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { endpoint_uuid: string }
          • endpoint_uuid: string

            Endpoint UUID

        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: { "application/json": { result: number } };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: { "application/json": { result: number } };
              headers: { [name: string]: unknown };
          }

          Successful Response

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

          Validation Error

    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { endpoint_uuid: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          config?: Record<string, unknown>;
                          description?: string;
                          display_name: string;
                          endpoint_config?: string;
                          endpoint_version?: string;
                          high_assurance: boolean;
                          hostname?: string;
                          ip_address?: string;
                          local_user?: string;
                          multi_user: boolean;
                          name: string;
                          public: boolean;
                          python_version?: string;
                          sdk_version?: string;
                          subscription_uuid?: string;
                          user_config_schema?: Record<string, unknown>;
                          user_config_template?: string;
                          uuid: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get Endpoint

      Retrieve the metadata for a given endpoint.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { endpoint_uuid: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { endpoint_uuid: string }
          • endpoint_uuid: string

            Endpoint UUID

        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        config?: Record<string, unknown>;
                        description?: string;
                        display_name: string;
                        endpoint_config?: string;
                        endpoint_version?: string;
                        high_assurance: boolean;
                        hostname?: string;
                        ip_address?: string;
                        local_user?: string;
                        multi_user: boolean;
                        name: string;
                        public: boolean;
                        python_version?: string;
                        sdk_version?: string;
                        subscription_uuid?: string;
                        user_config_schema?: Record<string, unknown>;
                        user_config_template?: string;
                        uuid: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      config?: Record<string, unknown>;
                      description?: string;
                      display_name: string;
                      endpoint_config?: string;
                      endpoint_version?: string;
                      high_assurance: boolean;
                      hostname?: string;
                      ip_address?: string;
                      local_user?: string;
                      multi_user: boolean;
                      name: string;
                      public: boolean;
                      python_version?: string;
                      sdk_version?: string;
                      subscription_uuid?: string;
                      user_config_schema?: Record<string, unknown>;
                      user_config_template?: string;
                      uuid: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

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

          Validation Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v2/endpoints/{endpoint_uuid}/lock": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { endpoint_uuid: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            endpoint_id: string;
                            lock_expiration_timestamp: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { endpoint_uuid: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          endpoint_id: string;
                          lock_expiration_timestamp: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Lock Endpoint

      Add a temporary lock to the endpoint to block registration requests and deletes the current RabbitMQ user/session such that existing endpoints, local or remote, shuts down upon losing credentials

      The POST body is ignored, as the URL and token contain the necessary info.
      
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { endpoint_uuid: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { endpoint_uuid: string }
          • endpoint_uuid: string

            Endpoint UUID

        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        endpoint_id: string;
                        lock_expiration_timestamp: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      endpoint_id: string;
                      lock_expiration_timestamp: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

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

          Validation Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v2/endpoints/{endpoint_uuid}/status": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { endpoint_uuid: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            details?: {
                                idle_workers: number;
                                managers?: number;
                                outstanding_tasks: number;
                                pending_tasks: number;
                                total_workers: number;
                            };
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { endpoint_uuid: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          details?: {
                              idle_workers: number;
                              managers?: number;
                              outstanding_tasks: number;
                              pending_tasks: number;
                              total_workers: number;
                          };
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get Endpoint Status

      Get the status of an endpoint.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { endpoint_uuid: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { endpoint_uuid: string }
          • endpoint_uuid: string

            Endpoint UUID

        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        details?: {
                            idle_workers: number;
                            managers?: number;
                            outstanding_tasks: number;
                            pending_tasks: number;
                            total_workers: number;
                        };
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      details?: {
                          idle_workers: number;
                          managers?: number;
                          outstanding_tasks: number;
                          pending_tasks: number;
                          total_workers: number;
                      };
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

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

          Validation Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v2/functions": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header: { "user-agent": string };
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        container_uuid?: string;
                        description?: string;
                        entry_point?: string;
                        function_code: string;
                        function_name: string;
                        group?: string;
                        metadata?: { python_version?: string; sdk_version?: string };
                        public: boolean;
                    };
                };
            };
            responses: {
                "200": {
                    content: { "application/json": { function_uuid: string } };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header: { "user-agent": string };
              path?: undefined;
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      container_uuid?: string;
                      description?: string;
                      entry_point?: string;
                      function_code: string;
                      function_name: string;
                      group?: string;
                      metadata?: { python_version?: string; sdk_version?: string };
                      public: boolean;
                  };
              };
          };
          responses: {
              "200": {
                  content: { "application/json": { function_uuid: string } };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Register Function

      Register a function.

      • parameters: {
            cookie?: undefined;
            header: { "user-agent": string };
            path?: undefined;
            query?: undefined;
        }
      • requestBody: {
            content: {
                "application/json": {
                    container_uuid?: string;
                    description?: string;
                    entry_point?: string;
                    function_code: string;
                    function_name: string;
                    group?: string;
                    metadata?: { python_version?: string; sdk_version?: string };
                    public: boolean;
                };
            };
        }
      • responses: {
            "200": {
                content: { "application/json": { function_uuid: string } };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: { "application/json": { function_uuid: string } };
              headers: { [name: string]: unknown };
          }

          Successful Response

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

          Validation Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v2/functions/{function_uuid}": {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { function_uuid: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: { "application/json": { result: number } };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { function_uuid: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            description?: string;
                            function_code: string;
                            function_name?: string;
                            function_uuid: string;
                            metadata: { python_version?: string; sdk_version?: string };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • delete: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { function_uuid: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: { "application/json": { result: number } };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Delete Function

      Delete a function.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { function_uuid: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { function_uuid: string }
          • function_uuid: string

            Function UUID

        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: { "application/json": { result: number } };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: { "application/json": { result: number } };
              headers: { [name: string]: unknown };
          }

          Successful Response

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

          Validation Error

    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { function_uuid: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          description?: string;
                          function_code: string;
                          function_name?: string;
                          function_uuid: string;
                          metadata: { python_version?: string; sdk_version?: string };
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get Function

      Get information about a registered function by providing its UUID.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { function_uuid: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { function_uuid: string }
          • function_uuid: string

            Function UUID

        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        description?: string;
                        function_code: string;
                        function_name?: string;
                        function_uuid: string;
                        metadata: { python_version?: string; sdk_version?: string };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      description?: string;
                      function_code: string;
                      function_name?: string;
                      function_uuid: string;
                      metadata: { python_version?: string; sdk_version?: string };
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

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

          Validation Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v2/get_amqp_result_connection_url": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": { connection_url: string; queue_prefix: string };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": { connection_url: string; queue_prefix: string };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get User Specific Result Amqp Url

      Generate new credentials (in the form of a connection URL) for connecting to the AMQP service. A new password is generated afresh every invocation, but the existing RMQ user, if any, is not deleted -- any existing connections will not be dropped. The RMQ user will have the vhost permissions set to only be allowed to read from queues with names prefixed by the user_uuid.

      • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": { connection_url: string; queue_prefix: string };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": { connection_url: string; queue_prefix: string };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v2/stats": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": { total_function_invocations: number };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": { total_function_invocations: number };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get Funcx Stats

      Get various usage stats.

      • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: { "application/json": { total_function_invocations: number } };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: { "application/json": { total_function_invocations: number } };
              headers: { [name: string]: unknown };
          }

          Successful Response

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v2/submit": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header: { "content-length": number };
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        create_websocket_queue: boolean;
                        task_group_id?: string;
                        tasks: [string, string, string][];
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            response: string;
                            results: (
                                | string
                                | {
                                    http_status_code: number;
                                    reason?: string;
                                    status: string;
                                    task_uuid: string;
                                }
                            )[];
                            task_group_id?: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header: { "content-length": number };
              path?: undefined;
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      create_websocket_queue: boolean;
                      task_group_id?: string;
                      tasks: [string, string, string][];
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          response: string;
                          results: (
                              | string
                              | {
                                  http_status_code: number;
                                  reason?: string;
                                  status: string;
                                  task_uuid: string;
                              }
                          )[];
                          task_group_id?: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Submit Batch

      Entry point for submitting tasks to Globus Compute Endpoints

      This route takes a list of tasks (specified as a tuple of a function id, an
      endpoint id, and a serialized string of arguments to that function); for each
      task, it will generate an AMQP packet with the task information, and route it
      to the endpoint-appropriate AMQP queue.  This route will then return a list
      of task ids that may be utilized to track each task's progress.
      
      Crucially, the order of the task id list returned corresponds to the order of
      the tasks submitted to this route.  In pseudo-code,
      `ids[0]`&nbsp;&rArr;&nbsp;`tasks[0]`, `ids[1]`&nbsp;&rArr;&nbsp;`tasks[1]`, ...,
      `ids[N]`&nbsp;&rArr;&nbsp;`tasks[N]`.
      
      • parameters: {
            cookie?: undefined;
            header: { "content-length": number };
            path?: undefined;
            query?: undefined;
        }
      • requestBody: {
            content: {
                "application/json": {
                    create_websocket_queue: boolean;
                    task_group_id?: string;
                    tasks: [string, string, string][];
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        response: string;
                        results: (
                            | string
                            | {
                                http_status_code: number;
                                reason?: string;
                                status: string;
                                task_uuid: string;
                            }
                        )[];
                        task_group_id?: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      response: string;
                      results: (
                          | string
                          | {
                              http_status_code: number;
                              reason?: string;
                              status: string;
                              task_uuid: string;
                          }
                      )[];
                      task_group_id?: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

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

          Validation Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v2/taskgroup/{task_group_uuid}": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { task_group_uuid: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            create_websockets_queue?: boolean;
                            taskgroup_id: string;
                            tasks: { created_at: string; id: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { task_group_uuid: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          create_websockets_queue?: boolean;
                          taskgroup_id: string;
                          tasks: { created_at: string; id: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get Task Group Tasks

      Retrieve all task UUIDs associated with a Task Group

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { task_group_uuid: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { task_group_uuid: string }
          • task_group_uuid: string

            Task Group UUID

        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        create_websockets_queue?: boolean;
                        taskgroup_id: string;
                        tasks: { created_at: string; id: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      create_websockets_queue?: boolean;
                      taskgroup_id: string;
                      tasks: { created_at: string; id: string }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

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

          Validation Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v2/tasks/{task_uuid}": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { task_uuid: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            completion_t?: string;
                            details?: Record<string, unknown>;
                            exception?: string;
                            result?: string;
                            status?: unknown;
                            task_id: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { task_uuid: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          completion_t?: string;
                          details?: Record<string, unknown>;
                          exception?: string;
                          result?: string;
                          status?: unknown;
                          task_id: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get Task Status And Result

      Check the status of a task.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { task_uuid: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { task_uuid: string }
          • task_uuid: string

            Task UUID

        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        completion_t?: string;
                        details?: Record<string, unknown>;
                        exception?: string;
                        result?: string;
                        status?: unknown;
                        task_id: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      completion_t?: string;
                      details?: Record<string, unknown>;
                      exception?: string;
                      result?: string;
                      status?: unknown;
                      task_id: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

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

          Validation Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v2/version": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: { service?: "all" | "api" };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": | string
                        | {
                            api: string;
                            container_service?: string;
                            git_sha?: string;
                            min_ep_version?: string;
                            min_sdk_version?: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: { service?: "all"
                | "api" };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: { "application/json": unknown };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: { service?: "all" | "api" };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": | string
                      | {
                          api: string;
                          container_service?: string;
                          git_sha?: string;
                          min_ep_version?: string;
                          min_sdk_version?: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get Version

      Get the version of the API and other services.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { service?: "all" | "api" };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • Optionalpath?: undefined
        • Optionalquery?: { service?: "all" | "api" }
          • Optionalservice?: "all" | "api"

            Service to get version for

      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json":
                        | string
                        | {
                            api: string;
                            container_service?: string;
                            git_sha?: string;
                            min_ep_version?: string;
                            min_sdk_version?: string;
                        };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json":
                      | string
                      | {
                          api: string;
                          container_service?: string;
                          git_sha?: string;
                          min_ep_version?: string;
                          min_sdk_version?: string;
                      };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

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

          Validation Error

    • head: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: { service?: "all" | "api" };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: { "application/json": unknown };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get Version

      Get the version of the API and other services.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: { service?: "all" | "api" };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • Optionalpath?: undefined
        • Optionalquery?: { service?: "all" | "api" }
          • Optionalservice?: "all" | "api"

            Service to get version for

      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: { "application/json": unknown };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: { "application/json": unknown };
              headers: { [name: string]: unknown };
          }

          Successful Response

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

          Validation Error

    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v3/endpoints": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header: {
                    "remote-addr"?: string;
                    "user-agent": string;
                    "x-forwarded-for"?: string;
                };
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        admins?: string[];
                        allowed_functions?: string[];
                        authentication_policy?: string;
                        display_name?: string;
                        endpoint_name: string;
                        high_assurance: boolean;
                        metadata: {
                            config?: Record<string, unknown>;
                            description?: string;
                            endpoint_config?: string;
                            endpoint_version?: string;
                            hostname?: string;
                            ip_address?: string;
                            local_user?: string;
                            python_version?: string;
                            sdk_version?: string;
                            user_config_schema?: Record<string, unknown>;
                            user_config_template?: string;
                        };
                        multi_user: boolean;
                        public: boolean;
                        subscription_uuid?: string;
                        version?: string;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": | {
                            endpoint_id: string;
                            heartbeat_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                                queue_publish_kwargs: {
                                    exchange: string;
                                    mandatory: boolean;
                                    properties: { delivery_mode: number };
                                    routing_key: string;
                                };
                            };
                            result_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                                queue_publish_kwargs: {
                                    exchange: string;
                                    mandatory: boolean;
                                    properties: { delivery_mode: number };
                                    routing_key: string;
                                };
                            };
                            task_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                            };
                            warnings?: string[];
                        }
                        | {
                            command_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                            };
                            endpoint_id: string;
                            heartbeat_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                                queue_publish_kwargs: {
                                    exchange: string;
                                    mandatory: boolean;
                                    properties: { delivery_mode: number };
                                    routing_key: string;
                                };
                            };
                            result_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                                queue_publish_kwargs: {
                                    exchange: string;
                                    mandatory: boolean;
                                    properties: { delivery_mode: number };
                                    routing_key: string;
                                };
                            };
                            warnings?: string[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: { loc: (string | number)[]; msg: string; type: string }[];
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "423": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header: {
                  "remote-addr"?: string;
                  "user-agent": string;
                  "x-forwarded-for"?: string;
              };
              path?: undefined;
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      admins?: string[];
                      allowed_functions?: string[];
                      authentication_policy?: string;
                      display_name?: string;
                      endpoint_name: string;
                      high_assurance: boolean;
                      metadata: {
                          config?: Record<string, unknown>;
                          description?: string;
                          endpoint_config?: string;
                          endpoint_version?: string;
                          hostname?: string;
                          ip_address?: string;
                          local_user?: string;
                          python_version?: string;
                          sdk_version?: string;
                          user_config_schema?: Record<string, unknown>;
                          user_config_template?: string;
                      };
                      multi_user: boolean;
                      public: boolean;
                      subscription_uuid?: string;
                      version?: string;
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": | {
                          endpoint_id: string;
                          heartbeat_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                              queue_publish_kwargs: {
                                  exchange: string;
                                  mandatory: boolean;
                                  properties: { delivery_mode: number };
                                  routing_key: string;
                              };
                          };
                          result_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                              queue_publish_kwargs: {
                                  exchange: string;
                                  mandatory: boolean;
                                  properties: { delivery_mode: number };
                                  routing_key: string;
                              };
                          };
                          task_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                          };
                          warnings?: string[];
                      }
                      | {
                          command_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                          };
                          endpoint_id: string;
                          heartbeat_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                              queue_publish_kwargs: {
                                  exchange: string;
                                  mandatory: boolean;
                                  properties: { delivery_mode: number };
                                  routing_key: string;
                              };
                          };
                          result_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                              queue_publish_kwargs: {
                                  exchange: string;
                                  mandatory: boolean;
                                  properties: { delivery_mode: number };
                                  routing_key: string;
                              };
                          };
                          warnings?: string[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: { loc: (string | number)[]; msg: string; type: string }[];
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "423": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Register Endpoint

      Register a new endpoint

      • parameters: {
            cookie?: undefined;
            header: {
                "remote-addr"?: string;
                "user-agent": string;
                "x-forwarded-for"?: string;
            };
            path?: undefined;
            query?: undefined;
        }
      • requestBody: {
            content: {
                "application/json": {
                    admins?: string[];
                    allowed_functions?: string[];
                    authentication_policy?: string;
                    display_name?: string;
                    endpoint_name: string;
                    high_assurance: boolean;
                    metadata: {
                        config?: Record<string, unknown>;
                        description?: string;
                        endpoint_config?: string;
                        endpoint_version?: string;
                        hostname?: string;
                        ip_address?: string;
                        local_user?: string;
                        python_version?: string;
                        sdk_version?: string;
                        user_config_schema?: Record<string, unknown>;
                        user_config_template?: string;
                    };
                    multi_user: boolean;
                    public: boolean;
                    subscription_uuid?: string;
                    version?: string;
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json":
                        | {
                            endpoint_id: string;
                            heartbeat_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                                queue_publish_kwargs: {
                                    exchange: string;
                                    mandatory: boolean;
                                    properties: { delivery_mode: number };
                                    routing_key: string;
                                };
                            };
                            result_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                                queue_publish_kwargs: {
                                    exchange: string;
                                    mandatory: boolean;
                                    properties: { delivery_mode: number };
                                    routing_key: string;
                                };
                            };
                            task_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                            };
                            warnings?: string[];
                        }
                        | {
                            command_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                            };
                            endpoint_id: string;
                            heartbeat_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                                queue_publish_kwargs: {
                                    exchange: string;
                                    mandatory: boolean;
                                    properties: { delivery_mode: number };
                                    routing_key: string;
                                };
                            };
                            result_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                                queue_publish_kwargs: {
                                    exchange: string;
                                    mandatory: boolean;
                                    properties: { delivery_mode: number };
                                    routing_key: string;
                                };
                            };
                            warnings?: string[];
                        };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: { loc: (string | number)[]; msg: string; type: string }[];
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "423": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json":
                      | {
                          endpoint_id: string;
                          heartbeat_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                              queue_publish_kwargs: {
                                  exchange: string;
                                  mandatory: boolean;
                                  properties: { delivery_mode: number };
                                  routing_key: string;
                              };
                          };
                          result_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                              queue_publish_kwargs: {
                                  exchange: string;
                                  mandatory: boolean;
                                  properties: { delivery_mode: number };
                                  routing_key: string;
                              };
                          };
                          task_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                          };
                          warnings?: string[];
                      }
                      | {
                          command_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                          };
                          endpoint_id: string;
                          heartbeat_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                              queue_publish_kwargs: {
                                  exchange: string;
                                  mandatory: boolean;
                                  properties: { delivery_mode: number };
                                  routing_key: string;
                              };
                          };
                          result_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                              queue_publish_kwargs: {
                                  exchange: string;
                                  mandatory: boolean;
                                  properties: { delivery_mode: number };
                                  routing_key: string;
                              };
                          };
                          warnings?: string[];
                      };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

        • 400: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 401: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unauthorized

        • 404: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Not Found

        • 422: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: { loc: (string | number)[]; msg: string; type: string }[];
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unprocessable Entity

        • 423: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Locked

        • 500: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v3/endpoints/{endpoint_uuid}": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put: {
            parameters: {
                cookie?: undefined;
                header: {
                    "remote-addr"?: string;
                    "user-agent": string;
                    "x-forwarded-for"?: string;
                };
                path: { endpoint_uuid: string };
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        admins?: string[];
                        allowed_functions?: string[];
                        authentication_policy?: string;
                        display_name?: string;
                        endpoint_name: string;
                        high_assurance: boolean;
                        metadata: {
                            config?: Record<string, unknown>;
                            description?: string;
                            endpoint_config?: string;
                            endpoint_version?: string;
                            hostname?: string;
                            ip_address?: string;
                            local_user?: string;
                            python_version?: string;
                            sdk_version?: string;
                            user_config_schema?: Record<string, unknown>;
                            user_config_template?: string;
                        };
                        multi_user: boolean;
                        public: boolean;
                        subscription_uuid?: string;
                        version?: string;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": | {
                            endpoint_id: string;
                            heartbeat_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                                queue_publish_kwargs: {
                                    exchange: string;
                                    mandatory: boolean;
                                    properties: { delivery_mode: number };
                                    routing_key: string;
                                };
                            };
                            result_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                                queue_publish_kwargs: {
                                    exchange: string;
                                    mandatory: boolean;
                                    properties: { delivery_mode: number };
                                    routing_key: string;
                                };
                            };
                            task_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                            };
                            warnings?: string[];
                        }
                        | {
                            command_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                            };
                            endpoint_id: string;
                            heartbeat_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                                queue_publish_kwargs: {
                                    exchange: string;
                                    mandatory: boolean;
                                    properties: { delivery_mode: number };
                                    routing_key: string;
                                };
                            };
                            result_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                                queue_publish_kwargs: {
                                    exchange: string;
                                    mandatory: boolean;
                                    properties: { delivery_mode: number };
                                    routing_key: string;
                                };
                            };
                            warnings?: string[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "409": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: { loc: (string | number)[]; msg: string; type: string }[];
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "423": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • put: {
          parameters: {
              cookie?: undefined;
              header: {
                  "remote-addr"?: string;
                  "user-agent": string;
                  "x-forwarded-for"?: string;
              };
              path: { endpoint_uuid: string };
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      admins?: string[];
                      allowed_functions?: string[];
                      authentication_policy?: string;
                      display_name?: string;
                      endpoint_name: string;
                      high_assurance: boolean;
                      metadata: {
                          config?: Record<string, unknown>;
                          description?: string;
                          endpoint_config?: string;
                          endpoint_version?: string;
                          hostname?: string;
                          ip_address?: string;
                          local_user?: string;
                          python_version?: string;
                          sdk_version?: string;
                          user_config_schema?: Record<string, unknown>;
                          user_config_template?: string;
                      };
                      multi_user: boolean;
                      public: boolean;
                      subscription_uuid?: string;
                      version?: string;
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": | {
                          endpoint_id: string;
                          heartbeat_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                              queue_publish_kwargs: {
                                  exchange: string;
                                  mandatory: boolean;
                                  properties: { delivery_mode: number };
                                  routing_key: string;
                              };
                          };
                          result_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                              queue_publish_kwargs: {
                                  exchange: string;
                                  mandatory: boolean;
                                  properties: { delivery_mode: number };
                                  routing_key: string;
                              };
                          };
                          task_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                          };
                          warnings?: string[];
                      }
                      | {
                          command_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                          };
                          endpoint_id: string;
                          heartbeat_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                              queue_publish_kwargs: {
                                  exchange: string;
                                  mandatory: boolean;
                                  properties: { delivery_mode: number };
                                  routing_key: string;
                              };
                          };
                          result_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                              queue_publish_kwargs: {
                                  exchange: string;
                                  mandatory: boolean;
                                  properties: { delivery_mode: number };
                                  routing_key: string;
                              };
                          };
                          warnings?: string[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "409": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: { loc: (string | number)[]; msg: string; type: string }[];
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "423": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Update Endpoint

      Check immutable flags against existing endpoint

      • parameters: {
            cookie?: undefined;
            header: {
                "remote-addr"?: string;
                "user-agent": string;
                "x-forwarded-for"?: string;
            };
            path: { endpoint_uuid: string };
            query?: undefined;
        }
      • requestBody: {
            content: {
                "application/json": {
                    admins?: string[];
                    allowed_functions?: string[];
                    authentication_policy?: string;
                    display_name?: string;
                    endpoint_name: string;
                    high_assurance: boolean;
                    metadata: {
                        config?: Record<string, unknown>;
                        description?: string;
                        endpoint_config?: string;
                        endpoint_version?: string;
                        hostname?: string;
                        ip_address?: string;
                        local_user?: string;
                        python_version?: string;
                        sdk_version?: string;
                        user_config_schema?: Record<string, unknown>;
                        user_config_template?: string;
                    };
                    multi_user: boolean;
                    public: boolean;
                    subscription_uuid?: string;
                    version?: string;
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json":
                        | {
                            endpoint_id: string;
                            heartbeat_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                                queue_publish_kwargs: {
                                    exchange: string;
                                    mandatory: boolean;
                                    properties: { delivery_mode: number };
                                    routing_key: string;
                                };
                            };
                            result_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                                queue_publish_kwargs: {
                                    exchange: string;
                                    mandatory: boolean;
                                    properties: { delivery_mode: number };
                                    routing_key: string;
                                };
                            };
                            task_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                            };
                            warnings?: string[];
                        }
                        | {
                            command_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                            };
                            endpoint_id: string;
                            heartbeat_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                                queue_publish_kwargs: {
                                    exchange: string;
                                    mandatory: boolean;
                                    properties: { delivery_mode: number };
                                    routing_key: string;
                                };
                            };
                            result_queue_info: {
                                connection_url: string;
                                exchange: string;
                                queue: string;
                                queue_publish_kwargs: {
                                    exchange: string;
                                    mandatory: boolean;
                                    properties: { delivery_mode: number };
                                    routing_key: string;
                                };
                            };
                            warnings?: string[];
                        };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "409": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: { loc: (string | number)[]; msg: string; type: string }[];
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "423": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json":
                      | {
                          endpoint_id: string;
                          heartbeat_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                              queue_publish_kwargs: {
                                  exchange: string;
                                  mandatory: boolean;
                                  properties: { delivery_mode: number };
                                  routing_key: string;
                              };
                          };
                          result_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                              queue_publish_kwargs: {
                                  exchange: string;
                                  mandatory: boolean;
                                  properties: { delivery_mode: number };
                                  routing_key: string;
                              };
                          };
                          task_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                          };
                          warnings?: string[];
                      }
                      | {
                          command_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                          };
                          endpoint_id: string;
                          heartbeat_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                              queue_publish_kwargs: {
                                  exchange: string;
                                  mandatory: boolean;
                                  properties: { delivery_mode: number };
                                  routing_key: string;
                              };
                          };
                          result_queue_info: {
                              connection_url: string;
                              exchange: string;
                              queue: string;
                              queue_publish_kwargs: {
                                  exchange: string;
                                  mandatory: boolean;
                                  properties: { delivery_mode: number };
                                  routing_key: string;
                              };
                          };
                          warnings?: string[];
                      };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

        • 400: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 401: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unauthorized

        • 403: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Not Found

        • 409: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Conflict

        • 422: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: { loc: (string | number)[]; msg: string; type: string }[];
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unprocessable Entity

        • 423: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Locked

        • 500: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionaltrace?: undefined
    "/v3/endpoints/{endpoint_uuid}/allowed_functions": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { endpoint_uuid: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            endpoint_id: string;
                            functions?: string[];
                            restricted: boolean;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { endpoint_uuid: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          endpoint_id: string;
                          functions?: string[];
                          restricted: boolean;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get Endpoint Allowlist

      Retrieve the UUIDs of the functions allowed to run on this endpoint

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { endpoint_uuid: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { endpoint_uuid: string }
          • endpoint_uuid: string

            Endpoint UUID

        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        endpoint_id: string;
                        functions?: string[];
                        restricted: boolean;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      endpoint_id: string;
                      functions?: string[];
                      restricted: boolean;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

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

          Validation Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v3/endpoints/{endpoint_uuid}/console": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { endpoint_uuid: string };
                query?: { include_fields?: string; user_endpoint_id?: string };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            user_endpoints: {
                                account?: string;
                                active: boolean;
                                client_sdk_versions?: string[];
                                config?: string;
                                endpoint_version?: string;
                                engine_type?: string;
                                executed_task_count?: number;
                                idle_worker_count?: number;
                                last_heartbeat_unix?: number;
                                node_info?: { [key: string]: (...)[] };
                                posix_pid?: number;
                                posix_username?: string;
                                provider_type?: string;
                                python_version?: string;
                                queue?: string;
                                queued_task_count?: number;
                                running_task_count?: number;
                                start_time_iso?: string;
                                start_time_unix?: number;
                                total_node_count?: number;
                                total_worker_count?: number;
                                user_endpoint_id: string;
                            }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: { loc: (string | number)[]; msg: string; type: string }[];
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { endpoint_uuid: string };
              query?: { include_fields?: string; user_endpoint_id?: string };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          user_endpoints: {
                              account?: string;
                              active: boolean;
                              client_sdk_versions?: string[];
                              config?: string;
                              endpoint_version?: string;
                              engine_type?: string;
                              executed_task_count?: number;
                              idle_worker_count?: number;
                              last_heartbeat_unix?: number;
                              node_info?: { [key: string]: (...)[] };
                              posix_pid?: number;
                              posix_username?: string;
                              provider_type?: string;
                              python_version?: string;
                              queue?: string;
                              queued_task_count?: number;
                              running_task_count?: number;
                              start_time_iso?: string;
                              start_time_unix?: number;
                              total_node_count?: number;
                              total_worker_count?: number;
                              user_endpoint_id: string;
                          }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: { loc: (string | number)[]; msg: string; type: string }[];
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get Endpoint Console Info

      Get operational information about a running multi-user endpoint.

      This route can only be accessed by the owner of the multi-user endpoint,
      which must have an associated Globus subscription.
      
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { endpoint_uuid: string };
            query?: { include_fields?: string; user_endpoint_id?: string };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { endpoint_uuid: string }
          • endpoint_uuid: string

            Multi-user endpoint UUID

        • Optionalquery?: { include_fields?: string; user_endpoint_id?: string }
          • Optionalinclude_fields?: string

            Comma separated list of user endpoint fields to include in the response. If left blank, all fields except 'config' are included. Invalid field names will result in a 400 error.

            user_endpoint_id,node_info,config
            
          • Optionaluser_endpoint_id?: string

            Provide the UUID of a specific user endpoint to return.

            99418dfd-2bcd-473c-a0b5-3aaedd855d82
            
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        user_endpoints: {
                            account?: string;
                            active: boolean;
                            client_sdk_versions?: string[];
                            config?: string;
                            endpoint_version?: string;
                            engine_type?: string;
                            executed_task_count?: number;
                            idle_worker_count?: number;
                            last_heartbeat_unix?: number;
                            node_info?: { [key: string]: (...)[] };
                            posix_pid?: number;
                            posix_username?: string;
                            provider_type?: string;
                            python_version?: string;
                            queue?: string;
                            queued_task_count?: number;
                            running_task_count?: number;
                            start_time_iso?: string;
                            start_time_unix?: number;
                            total_node_count?: number;
                            total_worker_count?: number;
                            user_endpoint_id: string;
                        }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: { loc: (string | number)[]; msg: string; type: string }[];
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      user_endpoints: {
                          account?: string;
                          active: boolean;
                          client_sdk_versions?: string[];
                          config?: string;
                          endpoint_version?: string;
                          engine_type?: string;
                          executed_task_count?: number;
                          idle_worker_count?: number;
                          last_heartbeat_unix?: number;
                          node_info?: { [key: string]: (...)[] };
                          posix_pid?: number;
                          posix_username?: string;
                          provider_type?: string;
                          python_version?: string;
                          queue?: string;
                          queued_task_count?: number;
                          running_task_count?: number;
                          start_time_iso?: string;
                          start_time_unix?: number;
                          total_node_count?: number;
                          total_worker_count?: number;
                          user_endpoint_id: string;
                      }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

        • 400: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Bad Request

        • 401: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unauthorized

        • 403: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Not Found

        • 422: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: { loc: (string | number)[]; msg: string; type: string }[];
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unprocessable Entity

        • 500: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v3/endpoints/{endpoint_uuid}/lock": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { endpoint_uuid: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            endpoint_id: string;
                            lock_expiration_timestamp: number;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: { loc: (string | number)[]; msg: string; type: string }[];
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { endpoint_uuid: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          endpoint_id: string;
                          lock_expiration_timestamp: number;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: { loc: (string | number)[]; msg: string; type: string }[];
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Lock Endpoint

      Temporarily block registration requests for the endpoint.

      The current AMQP user is also deleted, dropping any open connection.
      
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { endpoint_uuid: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { endpoint_uuid: string }
          • endpoint_uuid: string

            Endpoint UUID

        • Optionalquery?: undefined
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        endpoint_id: string;
                        lock_expiration_timestamp: number;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: { loc: (string | number)[]; msg: string; type: string }[];
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      endpoint_id: string;
                      lock_expiration_timestamp: number;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

        • 401: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unauthorized

        • 403: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Not Found

        • 422: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: { loc: (string | number)[]; msg: string; type: string }[];
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unprocessable Entity

        • 500: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v3/endpoints/{endpoint_uuid}/submit": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header: { "content-length": number; "user-agent": string };
                path: { endpoint_uuid: string };
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        create_queue: boolean;
                        resource_specification?: {
                            launcher_options?: string;
                            num_nodes: number;
                            num_ranks?: number;
                            ranks_per_node?: number;
                        };
                        result_serializers?: string[];
                        task_group_id?: string;
                        tasks: { [key: string]: string[] };
                        user_endpoint_config?: Record<string, unknown>;
                        user_runtime?: {
                            globus_compute_sdk_version?: string;
                            globus_sdk_version?: string;
                            python_version?: string;
                        };
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            endpoint_id: string;
                            request_id: string;
                            task_group_id: string;
                            tasks: { [key: string]: string[] };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "403": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "413": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: { loc: (string | number)[]; msg: string; type: string }[];
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header: { "content-length": number; "user-agent": string };
              path: { endpoint_uuid: string };
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      create_queue: boolean;
                      resource_specification?: {
                          launcher_options?: string;
                          num_nodes: number;
                          num_ranks?: number;
                          ranks_per_node?: number;
                      };
                      result_serializers?: string[];
                      task_group_id?: string;
                      tasks: { [key: string]: string[] };
                      user_endpoint_config?: Record<string, unknown>;
                      user_runtime?: {
                          globus_compute_sdk_version?: string;
                          globus_sdk_version?: string;
                          python_version?: string;
                      };
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          endpoint_id: string;
                          request_id: string;
                          task_group_id: string;
                          tasks: { [key: string]: string[] };
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "403": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "413": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: { loc: (string | number)[]; msg: string; type: string }[];
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Submit Batch

      Entry point for submitting tasks to a Globus Compute Endpoint

      This route takes a dictionary of function ids mapped to a list of serialized
      arguments destined for invocation at request&#8209;specified (single) endpoint.
      The returned data structure is similar, containing a mapping of the requested
      function ids to the associated list of task ids.  Of note is that the order of
      the returned task ids associated with each function id _is the same order_ as
      specified in the request.
      
      The `task_group_id` may be optionally specified if a set of tasks should be
      associated with a Task Group that was created in a previous interaction.
      However, if set and no task group already exists, the route will return an
      HTTP 404.
      
      • parameters: {
            cookie?: undefined;
            header: { "content-length": number; "user-agent": string };
            path: { endpoint_uuid: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • header: { "content-length": number; "user-agent": string }
        • path: { endpoint_uuid: string }
          • endpoint_uuid: string

            Endpoint UUID

        • Optionalquery?: undefined
      • requestBody: {
            content: {
                "application/json": {
                    create_queue: boolean;
                    resource_specification?: {
                        launcher_options?: string;
                        num_nodes: number;
                        num_ranks?: number;
                        ranks_per_node?: number;
                    };
                    result_serializers?: string[];
                    task_group_id?: string;
                    tasks: { [key: string]: string[] };
                    user_endpoint_config?: Record<string, unknown>;
                    user_runtime?: {
                        globus_compute_sdk_version?: string;
                        globus_sdk_version?: string;
                        python_version?: string;
                    };
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        endpoint_id: string;
                        request_id: string;
                        task_group_id: string;
                        tasks: { [key: string]: string[] };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "403": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "413": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: { loc: (string | number)[]; msg: string; type: string }[];
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      endpoint_id: string;
                      request_id: string;
                      task_group_id: string;
                      tasks: { [key: string]: string[] };
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

        • 401: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unauthorized

        • 403: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Forbidden

        • 404: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Not Found

        • 413: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Request Entity Too Large

        • 422: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: { loc: (string | number)[]; msg: string; type: string }[];
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unprocessable Entity

        • 500: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v3/functions": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        description?: string;
                        function_code: string;
                        function_name: string;
                        group?: string;
                        ha_endpoint_id?: string;
                        meta: {
                            python_version: string;
                            sdk_version: string;
                            serde_identifier: string;
                        };
                        public: boolean;
                    };
                };
            };
            responses: {
                "200": {
                    content: { "application/json": { function_uuid: string } };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "413": {
                    content: {
                        "application/json": {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": | {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: string;
                            status: string;
                        }
                        | {
                            code: string;
                            error_args: unknown[];
                            http_status_code: number;
                            reason: { loc: ((...) | (...))[]; msg: string; type: string }[];
                            status: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      description?: string;
                      function_code: string;
                      function_name: string;
                      group?: string;
                      ha_endpoint_id?: string;
                      meta: {
                          python_version: string;
                          sdk_version: string;
                          serde_identifier: string;
                      };
                      public: boolean;
                  };
              };
          };
          responses: {
              "200": {
                  content: { "application/json": { function_uuid: string } };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "413": {
                  content: {
                      "application/json": {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": | {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      }
                      | {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: { loc: ((...) | (...))[]; msg: string; type: string }[];
                          status: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Register Function

      Register a function

      • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
      • requestBody: {
            content: {
                "application/json": {
                    description?: string;
                    function_code: string;
                    function_name: string;
                    group?: string;
                    ha_endpoint_id?: string;
                    meta: {
                        python_version: string;
                        sdk_version: string;
                        serde_identifier: string;
                    };
                    public: boolean;
                };
            };
        }
      • responses: {
            "200": {
                content: { "application/json": { function_uuid: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "413": {
                content: {
                    "application/json": {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": | {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: string;
                        status: string;
                    }
                    | {
                        code: string;
                        error_args: unknown[];
                        http_status_code: number;
                        reason: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        status: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: { "application/json": { function_uuid: string } };
              headers: { [name: string]: unknown };
          }

          Successful Response

        • 401: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Unauthorized

        • 413: {
              content: {
                  "application/json": {
                      code: string;
                      error_args: unknown[];
                      http_status_code: number;
                      reason: string;
                      status: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Request Entity Too Large

        • 422: {
              content: {
                  "application/json":
                      | {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: string;
                          status: string;
                      }
                      | {
                          code: string;
                          error_args: unknown[];
                          http_status_code: number;
                          reason: { loc: ((...) | (...))[]; msg: string; type: string }[];
                          status: string;
                      };
              };
              headers: { [name: string]: unknown };
          }

          Unprocessable Entity

    • Optionalput?: undefined
    • Optionaltrace?: undefined