Interface components

interface components {
    headers: never;
    parameters: never;
    pathItems: never;
    requestBodies: never;
    responses: never;
    schemas: {
        AllowedFunctionsResponse: {
            endpoint_id: string;
            functions?: string[] | null;
            restricted: boolean;
        };
        BatchStatusRequest: { task_ids: string[] };
        BatchStatusResponse: {
            response: string;
            results: {
                [key: string]: {
                    completion_t?: string | null;
                    exception?: string | null;
                    reason?: string | null;
                    result?: string | null;
                    status: unknown;
                    task_id: string;
                };
            };
        };
        BatchStatusResponseResults: {
            completion_t?: string
            | null;
            exception?: string | null;
            reason?: string | null;
            result?: string | null;
            status: unknown;
            task_id: string;
        };
        BatchSubmitResponseTask: {
            http_status_code: number;
            reason?: string
            | null;
            status: string;
            task_uuid: string;
        };
        BuildStatus: | "failed"
        | "provided"
        | "submitted"
        | "initialized"
        | "queued"
        | "building"
        | "ready";
        compute_web_service__schemas__v2__endpoint__EndpointLockResponse: {
            endpoint_id: string;
            lock_expiration_timestamp: string;
        };
        compute_web_service__schemas__v2__endpoint__EndpointRegisterRequest: {
            allowed_functions?: string[]
            | null;
            authentication_policy?: string | null;
            display_name?: string | null;
            endpoint_name: string;
            endpoint_uuid: string;
            metadata?:
                | {
                    config?: { [key: string]: unknown }
                    | null;
                    description?: string | null;
                    endpoint_config?: string | null;
                    endpoint_version?: string | null;
                    hostname?: string | null;
                    ip_address?: string | null;
                    local_user?: string | null;
                    python_version?: string | null;
                    sdk_version?: string | null;
                    user_config_schema?: { [key: string]: unknown } | null;
                    user_config_template?: string | null;
                }
                | null;
            multi_user: boolean;
            version?: string
            | null;
        };
        compute_web_service__schemas__v2__function__RegisterFunctionMetadata: {
            python_version?: string
            | null;
            sdk_version?: string | null;
        };
        compute_web_service__schemas__v2__function__RegisterFunctionRequest: {
            container_uuid?: string
            | null;
            description?: string | null;
            entry_point?: string | null;
            function_code: string;
            function_name: string;
            group?: string | null;
            metadata?:
                | { python_version?: string
                | null; sdk_version?: string | null }
                | null;
            public: boolean;
        };
        compute_web_service__schemas__v2__function__RegisterFunctionResponse: {
            function_uuid: string;
        };
        compute_web_service__schemas__v2__task__BatchSubmitRequest: {
            create_websocket_queue: boolean;
            task_group_id?: string
            | null;
            tasks: [string, string, string][];
        };
        compute_web_service__schemas__v2__task__BatchSubmitResponse: {
            response: string;
            results: (
                | string
                | {
                    http_status_code: number;
                    reason?: string
                    | null;
                    status: string;
                    task_uuid: string;
                }
            )[];
            task_group_id?: string
            | null;
        };
        compute_web_service__schemas__v3__endpoints__EndpointLockResponse: {
            endpoint_id: string;
            lock_expiration_timestamp: number;
        };
        compute_web_service__schemas__v3__endpoints__EndpointRegisterRequest: {
            admins?: string[]
            | null;
            allowed_functions?: string[] | null;
            authentication_policy?: string | null;
            display_name?: string | null;
            endpoint_name: string;
            high_assurance: boolean;
            metadata: {
                config?: { [key: string]: unknown } | null;
                description?: string | null;
                endpoint_config?: string | null;
                endpoint_version?: string | null;
                hostname?: string | null;
                ip_address?: string | null;
                local_user?: string | null;
                python_version?: string | null;
                sdk_version?: string | null;
                user_config_schema?: { [key: string]: unknown } | null;
                user_config_template?: string | null;
            };
            multi_user: boolean;
            public: boolean;
            subscription_uuid?: string
            | null;
            version?: string | null;
        };
        compute_web_service__schemas__v3__function__RegisterFunctionMetadata: {
            python_version: string;
            sdk_version: string;
            serde_identifier: string;
        };
        compute_web_service__schemas__v3__function__RegisterFunctionRequest: {
            description?: string
            | null;
            function_code: string;
            function_name: string;
            group?: string | null;
            ha_endpoint_id?: string | null;
            meta: {
                python_version: string;
                sdk_version: string;
                serde_identifier: string;
            };
            public: boolean;
        };
        compute_web_service__schemas__v3__function__RegisterFunctionResponse: {
            function_uuid: string;
            ha_warning?: string
            | null;
        };
        compute_web_service__schemas__v3__tasks__BatchSubmitRequest: {
            create_queue: boolean;
            resource_specification?: | {
                launcher_options?: string
                | null;
                num_nodes: number;
                num_ranks?: number | null;
                ranks_per_node?: number | null;
            }
            | null;
            result_serializers?: string[]
            | null;
            task_group_id?: string | null;
            tasks: { [key: string]: string[] };
            user_endpoint_config?: { [key: string]: unknown } | null;
            user_runtime?:
                | {
                    globus_compute_sdk_version?: string
                    | null;
                    globus_sdk_version?: string | null;
                    platform?:
                        | {
                            architecture?: [string, string]
                            | null;
                            machine?: string | null;
                            node?: string | null;
                            platform?: string | null;
                            processor?: string | null;
                            release?: string | null;
                        }
                        | null;
                    python?: | {
                        compiler?: string
                        | null;
                        implementation?: string | null;
                        version?: string | null;
                        version_description?: string | null;
                        version_info?: [number, number, number, string, number] | null;
                        version_tuple?: [number, number, number] | null;
                    }
                    | null;
                    python_version?: string
                    | null;
                }
                | null;
        };
        compute_web_service__schemas__v3__tasks__BatchSubmitResponse: {
            endpoint_id: string;
            ha_warning?: string
            | null;
            request_id: string;
            task_group_id: string;
            tasks: { [key: string]: string[] };
        };
        ComputeVersionResponse: {
            api: string;
            container_service?: string
            | null;
            git_sha?: string | null;
            min_ep_version?: string | null;
            min_sdk_version?: string | null;
        };
        ConsoleNodeInfo: {
            endpoint_version?: string
            | null;
            idle_duration_seconds?: number | null;
            python_version?: string | null;
            sdk_version?: string | null;
            total_worker_count?: number | null;
        };
        ConsoleResponse: {
            user_endpoints: {
                account?: string
                | null;
                active: boolean;
                client_sdk_versions?: string[];
                config?: string | null;
                endpoint_version?: string | null;
                engine_type?: string | null;
                executed_task_count?: number | null;
                idle_worker_count?: number | null;
                last_heartbeat_unix?: number | null;
                node_info?:
                    | {
                        [key: string]: {
                            endpoint_version?: string
                            | null;
                            idle_duration_seconds?: number | null;
                            python_version?: string | null;
                            sdk_version?: string | null;
                            total_worker_count?: number | null;
                        }[];
                    }
                    | null;
                posix_pid?: number
                | null;
                posix_username?: string | null;
                provider_type?: string | null;
                python_version?: string | null;
                queue?: string | null;
                queued_task_count?: number | null;
                running_task_count?: number | null;
                start_time_iso?: string | null;
                start_time_unix?: number | null;
                total_node_count?: number | null;
                total_worker_count?: number | null;
                user_endpoint_id: string;
            }[];
        };
        ConsoleUserEndpointInfo: {
            account?: string
            | null;
            active: boolean;
            client_sdk_versions?: string[];
            config?: string | null;
            endpoint_version?: string | null;
            engine_type?: string | null;
            executed_task_count?: number | null;
            idle_worker_count?: number | null;
            last_heartbeat_unix?: number | null;
            node_info?:
                | {
                    [key: string]: {
                        endpoint_version?: string
                        | null;
                        idle_duration_seconds?: number | null;
                        python_version?: string | null;
                        sdk_version?: string | null;
                        total_worker_count?: number | null;
                    }[];
                }
                | null;
            posix_pid?: number
            | null;
            posix_username?: string | null;
            provider_type?: string | null;
            python_version?: string | null;
            queue?: string | null;
            queued_task_count?: number | null;
            running_task_count?: number | null;
            start_time_iso?: string | null;
            start_time_unix?: number | null;
            total_node_count?: number | null;
            total_worker_count?: number | null;
            user_endpoint_id: string;
        };
        ContainerBuildRequest: {
            apt: string[];
            conda: string[];
            description?: string
            | null;
            name: string;
            payload_url?: string | null;
            pip: string[];
        };
        ContainerBuildResponse: { container_id: string };
        ContainerBuildStatusResponse: {
            status:
                | "failed"
                | "provided"
                | "submitted"
                | "initialized"
                | "queued"
                | "building"
                | "ready";
        };
        ContainerRegisterRequest: {
            description?: string
            | null;
            location: string;
            name: string;
            type: "docker" | "singularity";
        };
        ContainerRegisterResponse: { container_id: string };
        ContainerRuntime: "docker" | "singularity";
        ContainerStatus: {
            build_status:
                | "failed"
                | "provided"
                | "submitted"
                | "initialized"
                | "queued"
                | "building"
                | "ready";
            build_stderr?: string
            | null;
            container_uuid: string;
            err_message?: string | null;
            location?: string | null;
            name: string;
            type?: "docker" | "singularity" | null;
        };
        ContainerStatusResponse: {
            container: {
                build_status: | "failed"
                | "provided"
                | "submitted"
                | "initialized"
                | "queued"
                | "building"
                | "ready";
                build_stderr?: string
                | null;
                container_uuid: string;
                err_message?: string | null;
                location?: string | null;
                name: string;
                type?: "docker" | "singularity" | null;
            };
        };
        DeleteFunctionResponse: { result: number };
        Endpoint: {
            config?: { [key: string]: unknown } | null;
            description?: string | null;
            display_name: string;
            endpoint_config?: string | null;
            endpoint_version?: string | null;
            high_assurance: boolean;
            hostname?: string | null;
            ip_address?: string | null;
            local_user?: string | null;
            multi_user: boolean;
            name: string;
            public: boolean;
            python_version?: string | null;
            sdk_version?: string | null;
            subscription_admin_verified: boolean;
            subscription_uuid?: string | null;
            user_config_schema?: { [key: string]: unknown } | null;
            user_config_template?: string | null;
            uuid: string;
        };
        EndpointConfig: {
            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[]
            | null;
        };
        EndpointConfigQueueInfo: {
            connection_url: string;
            exchange: string;
            queue: string;
        };
        EndpointConfigResultQueue: {
            connection_url: string;
            exchange: string;
            queue: string;
            queue_publish_kwargs: {
                exchange: string;
                mandatory: boolean;
                properties: { delivery_mode: number };
                routing_key: string;
            };
        };
        EndpointConfigResultQueuePublish: {
            exchange: string;
            mandatory: boolean;
            properties: { delivery_mode: number };
            routing_key: string;
        };
        EndpointConfigResultQueuePublishProperties: { delivery_mode: number };
        EndpointDeleteResponse: { result: number };
        EndpointListResponseEntry: {
            display_name: string;
            name: string;
            owner: string;
            uuid: string;
        };
        EndpointMetadata: {
            config?: { [key: string]: unknown }
            | null;
            description?: string | null;
            endpoint_config?: string | null;
            endpoint_version?: string | null;
            hostname?: string | null;
            ip_address?: string | null;
            local_user?: string | null;
            python_version?: string | null;
            sdk_version?: string | null;
            user_config_schema?: { [key: string]: unknown } | null;
            user_config_template?: string | null;
        };
        EndpointRegisterMetadata: {
            config?: { [key: string]: unknown }
            | null;
            description?: string | null;
            endpoint_config?: string | null;
            endpoint_version?: string | null;
            hostname?: string | null;
            ip_address?: string | null;
            local_user?: string | null;
            python_version?: string | null;
            sdk_version?: string | null;
            user_config_schema?: { [key: string]: unknown } | null;
            user_config_template?: string | null;
        };
        EndpointRegisterResponse: {
            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[]
            | null;
        };
        EndpointStatusDetails: {
            idle_workers: number
            | "NaN"
            | "Infinity"
            | "-Infinity";
            managers?: number | "NaN" | "Infinity" | "-Infinity" | null;
            outstanding_tasks: number | "NaN" | "Infinity" | "-Infinity";
            pending_tasks: number | "NaN" | "Infinity" | "-Infinity";
            total_workers: number | "NaN" | "Infinity" | "-Infinity";
        } & { [key: string]: unknown };
        EndpointStatusResponse: {
            details?:
                | {
                    idle_workers: number
                    | "NaN"
                    | "Infinity"
                    | "-Infinity";
                    managers?: number | "NaN" | "Infinity" | "-Infinity" | null;
                    outstanding_tasks: number | "NaN" | "Infinity" | "-Infinity";
                    pending_tasks: number | "NaN" | "Infinity" | "-Infinity";
                    total_workers: number | "NaN" | "Infinity" | "-Infinity";
                } & { [key: string]: unknown }
                | null;
            status: string;
        };
        ErrorResponse: {
            code: string;
            detail: string;
            error_args: unknown[];
            http_status_code: number;
            reason: string;
            status: string;
        };
        Function: {
            description?: string
            | null;
            function_code: string;
            function_name?: string | null;
            function_uuid: string;
            metadata: { python_version?: string | null; sdk_version?: string | null };
        };
        FunctionMetadata: {
            python_version?: string
            | null;
            sdk_version?: string | null;
        };
        HTTPValidationError: {
            detail?: {
                ctx?: Record<string, unknown>;
                input?: unknown;
                loc: (string | number)[];
                msg: string;
                type: string;
            }[];
        };
        MultiUserEndpointConfig: {
            command_queue_info: {
                connection_url: string;
                exchange: string;
                queue: string;
            };
            endpoint_id: string;
            warnings?: string[]
            | null;
        };
        MultiUserEndpointRegisterResponse: {
            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[]
            | null;
        };
        PlatformInfo: {
            architecture?: [string, string]
            | null;
            machine?: string | null;
            node?: string | null;
            platform?: string | null;
            processor?: string | null;
            release?: string | null;
        };
        PythonInfo: {
            compiler?: string
            | null;
            implementation?: string | null;
            version?: string | null;
            version_description?: string | null;
            version_info?: [number, number, number, string, number] | null;
            version_tuple?: [number, number, number] | null;
        };
        ReadQueueInfo: { connection_url: string; exchange: string; queue: string };
        ResourceSpecification: {
            launcher_options?: string | null;
            num_nodes: number;
            num_ranks?: number | null;
            ranks_per_node?: number | null;
        };
        ResultAmqpUrlResponse: { connection_url: string; queue_prefix: string };
        SubscriptionAdminVerified: { subscription_admin_verified: boolean };
        TaskGroupResponse: {
            create_websockets_queue?: boolean | null;
            taskgroup_id: string;
            tasks: { created_at: string; id: string }[];
        };
        TaskGroupResponseTask: { created_at: string; id: string };
        TaskStatusResponse: {
            completion_t?: string | null;
            details?: { [key: string]: unknown } | null;
            exception?: string | null;
            result?: string | null;
            status: unknown;
            task_id: string;
        };
        UserRuntime: {
            globus_compute_sdk_version?: string
            | null;
            globus_sdk_version?: string | null;
            platform?:
                | {
                    architecture?: [string, string]
                    | null;
                    machine?: string | null;
                    node?: string | null;
                    platform?: string | null;
                    processor?: string | null;
                    release?: string | null;
                }
                | null;
            python?: | {
                compiler?: string
                | null;
                implementation?: string | null;
                version?: string | null;
                version_description?: string | null;
                version_info?: [number, number, number, string, number] | null;
                version_tuple?: [number, number, number] | null;
            }
            | null;
            python_version?: string
            | null;
        };
        ValidationError: {
            ctx?: Record<string, unknown>;
            input?: unknown;
            loc: (string | number)[];
            msg: string;
            type: string;
        };
        ValidationErrorResponse: {
            code: string;
            detail: {
                ctx?: Record<string, unknown>;
                input?: unknown;
                loc: (string | number)[];
                msg: string;
                type: string;
            }[];
            error_args: unknown[];
            http_status_code: number;
            reason: {
                ctx?: Record<string, unknown>;
                input?: unknown;
                loc: (string | number)[];
                msg: string;
                type: string;
            }[];
            status: string;
        };
        VersionService: "all"
        | "api";
        WriteQueueInfo: {
            connection_url: string;
            exchange: string;
            queue: string;
            queue_publish_kwargs: {
                exchange: string;
                mandatory: boolean;
                properties: { delivery_mode: number };
                routing_key: string;
            };
        };
        WriteQueuePublishKwargs: {
            exchange: string;
            mandatory: boolean;
            properties: { delivery_mode: number };
            routing_key: string;
        };
        WriteQueuePublishProperties: { delivery_mode: number };
    };
}

Index

Properties

headers parameters pathItems requestBodies responses schemas

Properties

headers

headers: never

parameters

parameters: never

pathItems

pathItems: never

requestBodies

requestBodies: never

responses

responses: never

schemas

schemas: {
    AllowedFunctionsResponse: {
        endpoint_id: string;
        functions?: string[] | null;
        restricted: boolean;
    };
    BatchStatusRequest: { task_ids: string[] };
    BatchStatusResponse: {
        response: string;
        results: {
            [key: string]: {
                completion_t?: string | null;
                exception?: string | null;
                reason?: string | null;
                result?: string | null;
                status: unknown;
                task_id: string;
            };
        };
    };
    BatchStatusResponseResults: {
        completion_t?: string
        | null;
        exception?: string | null;
        reason?: string | null;
        result?: string | null;
        status: unknown;
        task_id: string;
    };
    BatchSubmitResponseTask: {
        http_status_code: number;
        reason?: string
        | null;
        status: string;
        task_uuid: string;
    };
    BuildStatus: | "failed"
    | "provided"
    | "submitted"
    | "initialized"
    | "queued"
    | "building"
    | "ready";
    compute_web_service__schemas__v2__endpoint__EndpointLockResponse: {
        endpoint_id: string;
        lock_expiration_timestamp: string;
    };
    compute_web_service__schemas__v2__endpoint__EndpointRegisterRequest: {
        allowed_functions?: string[]
        | null;
        authentication_policy?: string | null;
        display_name?: string | null;
        endpoint_name: string;
        endpoint_uuid: string;
        metadata?:
            | {
                config?: { [key: string]: unknown }
                | null;
                description?: string | null;
                endpoint_config?: string | null;
                endpoint_version?: string | null;
                hostname?: string | null;
                ip_address?: string | null;
                local_user?: string | null;
                python_version?: string | null;
                sdk_version?: string | null;
                user_config_schema?: { [key: string]: unknown } | null;
                user_config_template?: string | null;
            }
            | null;
        multi_user: boolean;
        version?: string
        | null;
    };
    compute_web_service__schemas__v2__function__RegisterFunctionMetadata: {
        python_version?: string
        | null;
        sdk_version?: string | null;
    };
    compute_web_service__schemas__v2__function__RegisterFunctionRequest: {
        container_uuid?: string
        | null;
        description?: string | null;
        entry_point?: string | null;
        function_code: string;
        function_name: string;
        group?: string | null;
        metadata?:
            | { python_version?: string
            | null; sdk_version?: string | null }
            | null;
        public: boolean;
    };
    compute_web_service__schemas__v2__function__RegisterFunctionResponse: {
        function_uuid: string;
    };
    compute_web_service__schemas__v2__task__BatchSubmitRequest: {
        create_websocket_queue: boolean;
        task_group_id?: string
        | null;
        tasks: [string, string, string][];
    };
    compute_web_service__schemas__v2__task__BatchSubmitResponse: {
        response: string;
        results: (
            | string
            | {
                http_status_code: number;
                reason?: string
                | null;
                status: string;
                task_uuid: string;
            }
        )[];
        task_group_id?: string
        | null;
    };
    compute_web_service__schemas__v3__endpoints__EndpointLockResponse: {
        endpoint_id: string;
        lock_expiration_timestamp: number;
    };
    compute_web_service__schemas__v3__endpoints__EndpointRegisterRequest: {
        admins?: string[]
        | null;
        allowed_functions?: string[] | null;
        authentication_policy?: string | null;
        display_name?: string | null;
        endpoint_name: string;
        high_assurance: boolean;
        metadata: {
            config?: { [key: string]: unknown } | null;
            description?: string | null;
            endpoint_config?: string | null;
            endpoint_version?: string | null;
            hostname?: string | null;
            ip_address?: string | null;
            local_user?: string | null;
            python_version?: string | null;
            sdk_version?: string | null;
            user_config_schema?: { [key: string]: unknown } | null;
            user_config_template?: string | null;
        };
        multi_user: boolean;
        public: boolean;
        subscription_uuid?: string
        | null;
        version?: string | null;
    };
    compute_web_service__schemas__v3__function__RegisterFunctionMetadata: {
        python_version: string;
        sdk_version: string;
        serde_identifier: string;
    };
    compute_web_service__schemas__v3__function__RegisterFunctionRequest: {
        description?: string
        | null;
        function_code: string;
        function_name: string;
        group?: string | null;
        ha_endpoint_id?: string | null;
        meta: {
            python_version: string;
            sdk_version: string;
            serde_identifier: string;
        };
        public: boolean;
    };
    compute_web_service__schemas__v3__function__RegisterFunctionResponse: {
        function_uuid: string;
        ha_warning?: string
        | null;
    };
    compute_web_service__schemas__v3__tasks__BatchSubmitRequest: {
        create_queue: boolean;
        resource_specification?: | {
            launcher_options?: string
            | null;
            num_nodes: number;
            num_ranks?: number | null;
            ranks_per_node?: number | null;
        }
        | null;
        result_serializers?: string[]
        | null;
        task_group_id?: string | null;
        tasks: { [key: string]: string[] };
        user_endpoint_config?: { [key: string]: unknown } | null;
        user_runtime?:
            | {
                globus_compute_sdk_version?: string
                | null;
                globus_sdk_version?: string | null;
                platform?:
                    | {
                        architecture?: [string, string]
                        | null;
                        machine?: string | null;
                        node?: string | null;
                        platform?: string | null;
                        processor?: string | null;
                        release?: string | null;
                    }
                    | null;
                python?: | {
                    compiler?: string
                    | null;
                    implementation?: string | null;
                    version?: string | null;
                    version_description?: string | null;
                    version_info?: [number, number, number, string, number] | null;
                    version_tuple?: [number, number, number] | null;
                }
                | null;
                python_version?: string
                | null;
            }
            | null;
    };
    compute_web_service__schemas__v3__tasks__BatchSubmitResponse: {
        endpoint_id: string;
        ha_warning?: string
        | null;
        request_id: string;
        task_group_id: string;
        tasks: { [key: string]: string[] };
    };
    ComputeVersionResponse: {
        api: string;
        container_service?: string
        | null;
        git_sha?: string | null;
        min_ep_version?: string | null;
        min_sdk_version?: string | null;
    };
    ConsoleNodeInfo: {
        endpoint_version?: string
        | null;
        idle_duration_seconds?: number | null;
        python_version?: string | null;
        sdk_version?: string | null;
        total_worker_count?: number | null;
    };
    ConsoleResponse: {
        user_endpoints: {
            account?: string
            | null;
            active: boolean;
            client_sdk_versions?: string[];
            config?: string | null;
            endpoint_version?: string | null;
            engine_type?: string | null;
            executed_task_count?: number | null;
            idle_worker_count?: number | null;
            last_heartbeat_unix?: number | null;
            node_info?:
                | {
                    [key: string]: {
                        endpoint_version?: string
                        | null;
                        idle_duration_seconds?: number | null;
                        python_version?: string | null;
                        sdk_version?: string | null;
                        total_worker_count?: number | null;
                    }[];
                }
                | null;
            posix_pid?: number
            | null;
            posix_username?: string | null;
            provider_type?: string | null;
            python_version?: string | null;
            queue?: string | null;
            queued_task_count?: number | null;
            running_task_count?: number | null;
            start_time_iso?: string | null;
            start_time_unix?: number | null;
            total_node_count?: number | null;
            total_worker_count?: number | null;
            user_endpoint_id: string;
        }[];
    };
    ConsoleUserEndpointInfo: {
        account?: string
        | null;
        active: boolean;
        client_sdk_versions?: string[];
        config?: string | null;
        endpoint_version?: string | null;
        engine_type?: string | null;
        executed_task_count?: number | null;
        idle_worker_count?: number | null;
        last_heartbeat_unix?: number | null;
        node_info?:
            | {
                [key: string]: {
                    endpoint_version?: string
                    | null;
                    idle_duration_seconds?: number | null;
                    python_version?: string | null;
                    sdk_version?: string | null;
                    total_worker_count?: number | null;
                }[];
            }
            | null;
        posix_pid?: number
        | null;
        posix_username?: string | null;
        provider_type?: string | null;
        python_version?: string | null;
        queue?: string | null;
        queued_task_count?: number | null;
        running_task_count?: number | null;
        start_time_iso?: string | null;
        start_time_unix?: number | null;
        total_node_count?: number | null;
        total_worker_count?: number | null;
        user_endpoint_id: string;
    };
    ContainerBuildRequest: {
        apt: string[];
        conda: string[];
        description?: string
        | null;
        name: string;
        payload_url?: string | null;
        pip: string[];
    };
    ContainerBuildResponse: { container_id: string };
    ContainerBuildStatusResponse: {
        status:
            | "failed"
            | "provided"
            | "submitted"
            | "initialized"
            | "queued"
            | "building"
            | "ready";
    };
    ContainerRegisterRequest: {
        description?: string
        | null;
        location: string;
        name: string;
        type: "docker" | "singularity";
    };
    ContainerRegisterResponse: { container_id: string };
    ContainerRuntime: "docker" | "singularity";
    ContainerStatus: {
        build_status:
            | "failed"
            | "provided"
            | "submitted"
            | "initialized"
            | "queued"
            | "building"
            | "ready";
        build_stderr?: string
        | null;
        container_uuid: string;
        err_message?: string | null;
        location?: string | null;
        name: string;
        type?: "docker" | "singularity" | null;
    };
    ContainerStatusResponse: {
        container: {
            build_status: | "failed"
            | "provided"
            | "submitted"
            | "initialized"
            | "queued"
            | "building"
            | "ready";
            build_stderr?: string
            | null;
            container_uuid: string;
            err_message?: string | null;
            location?: string | null;
            name: string;
            type?: "docker" | "singularity" | null;
        };
    };
    DeleteFunctionResponse: { result: number };
    Endpoint: {
        config?: { [key: string]: unknown } | null;
        description?: string | null;
        display_name: string;
        endpoint_config?: string | null;
        endpoint_version?: string | null;
        high_assurance: boolean;
        hostname?: string | null;
        ip_address?: string | null;
        local_user?: string | null;
        multi_user: boolean;
        name: string;
        public: boolean;
        python_version?: string | null;
        sdk_version?: string | null;
        subscription_admin_verified: boolean;
        subscription_uuid?: string | null;
        user_config_schema?: { [key: string]: unknown } | null;
        user_config_template?: string | null;
        uuid: string;
    };
    EndpointConfig: {
        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[]
        | null;
    };
    EndpointConfigQueueInfo: {
        connection_url: string;
        exchange: string;
        queue: string;
    };
    EndpointConfigResultQueue: {
        connection_url: string;
        exchange: string;
        queue: string;
        queue_publish_kwargs: {
            exchange: string;
            mandatory: boolean;
            properties: { delivery_mode: number };
            routing_key: string;
        };
    };
    EndpointConfigResultQueuePublish: {
        exchange: string;
        mandatory: boolean;
        properties: { delivery_mode: number };
        routing_key: string;
    };
    EndpointConfigResultQueuePublishProperties: { delivery_mode: number };
    EndpointDeleteResponse: { result: number };
    EndpointListResponseEntry: {
        display_name: string;
        name: string;
        owner: string;
        uuid: string;
    };
    EndpointMetadata: {
        config?: { [key: string]: unknown }
        | null;
        description?: string | null;
        endpoint_config?: string | null;
        endpoint_version?: string | null;
        hostname?: string | null;
        ip_address?: string | null;
        local_user?: string | null;
        python_version?: string | null;
        sdk_version?: string | null;
        user_config_schema?: { [key: string]: unknown } | null;
        user_config_template?: string | null;
    };
    EndpointRegisterMetadata: {
        config?: { [key: string]: unknown }
        | null;
        description?: string | null;
        endpoint_config?: string | null;
        endpoint_version?: string | null;
        hostname?: string | null;
        ip_address?: string | null;
        local_user?: string | null;
        python_version?: string | null;
        sdk_version?: string | null;
        user_config_schema?: { [key: string]: unknown } | null;
        user_config_template?: string | null;
    };
    EndpointRegisterResponse: {
        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[]
        | null;
    };
    EndpointStatusDetails: {
        idle_workers: number
        | "NaN"
        | "Infinity"
        | "-Infinity";
        managers?: number | "NaN" | "Infinity" | "-Infinity" | null;
        outstanding_tasks: number | "NaN" | "Infinity" | "-Infinity";
        pending_tasks: number | "NaN" | "Infinity" | "-Infinity";
        total_workers: number | "NaN" | "Infinity" | "-Infinity";
    } & { [key: string]: unknown };
    EndpointStatusResponse: {
        details?:
            | {
                idle_workers: number
                | "NaN"
                | "Infinity"
                | "-Infinity";
                managers?: number | "NaN" | "Infinity" | "-Infinity" | null;
                outstanding_tasks: number | "NaN" | "Infinity" | "-Infinity";
                pending_tasks: number | "NaN" | "Infinity" | "-Infinity";
                total_workers: number | "NaN" | "Infinity" | "-Infinity";
            } & { [key: string]: unknown }
            | null;
        status: string;
    };
    ErrorResponse: {
        code: string;
        detail: string;
        error_args: unknown[];
        http_status_code: number;
        reason: string;
        status: string;
    };
    Function: {
        description?: string
        | null;
        function_code: string;
        function_name?: string | null;
        function_uuid: string;
        metadata: { python_version?: string | null; sdk_version?: string | null };
    };
    FunctionMetadata: {
        python_version?: string
        | null;
        sdk_version?: string | null;
    };
    HTTPValidationError: {
        detail?: {
            ctx?: Record<string, unknown>;
            input?: unknown;
            loc: (string | number)[];
            msg: string;
            type: string;
        }[];
    };
    MultiUserEndpointConfig: {
        command_queue_info: {
            connection_url: string;
            exchange: string;
            queue: string;
        };
        endpoint_id: string;
        warnings?: string[]
        | null;
    };
    MultiUserEndpointRegisterResponse: {
        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[]
        | null;
    };
    PlatformInfo: {
        architecture?: [string, string]
        | null;
        machine?: string | null;
        node?: string | null;
        platform?: string | null;
        processor?: string | null;
        release?: string | null;
    };
    PythonInfo: {
        compiler?: string
        | null;
        implementation?: string | null;
        version?: string | null;
        version_description?: string | null;
        version_info?: [number, number, number, string, number] | null;
        version_tuple?: [number, number, number] | null;
    };
    ReadQueueInfo: { connection_url: string; exchange: string; queue: string };
    ResourceSpecification: {
        launcher_options?: string | null;
        num_nodes: number;
        num_ranks?: number | null;
        ranks_per_node?: number | null;
    };
    ResultAmqpUrlResponse: { connection_url: string; queue_prefix: string };
    SubscriptionAdminVerified: { subscription_admin_verified: boolean };
    TaskGroupResponse: {
        create_websockets_queue?: boolean | null;
        taskgroup_id: string;
        tasks: { created_at: string; id: string }[];
    };
    TaskGroupResponseTask: { created_at: string; id: string };
    TaskStatusResponse: {
        completion_t?: string | null;
        details?: { [key: string]: unknown } | null;
        exception?: string | null;
        result?: string | null;
        status: unknown;
        task_id: string;
    };
    UserRuntime: {
        globus_compute_sdk_version?: string
        | null;
        globus_sdk_version?: string | null;
        platform?:
            | {
                architecture?: [string, string]
                | null;
                machine?: string | null;
                node?: string | null;
                platform?: string | null;
                processor?: string | null;
                release?: string | null;
            }
            | null;
        python?: | {
            compiler?: string
            | null;
            implementation?: string | null;
            version?: string | null;
            version_description?: string | null;
            version_info?: [number, number, number, string, number] | null;
            version_tuple?: [number, number, number] | null;
        }
        | null;
        python_version?: string
        | null;
    };
    ValidationError: {
        ctx?: Record<string, unknown>;
        input?: unknown;
        loc: (string | number)[];
        msg: string;
        type: string;
    };
    ValidationErrorResponse: {
        code: string;
        detail: {
            ctx?: Record<string, unknown>;
            input?: unknown;
            loc: (string | number)[];
            msg: string;
            type: string;
        }[];
        error_args: unknown[];
        http_status_code: number;
        reason: {
            ctx?: Record<string, unknown>;
            input?: unknown;
            loc: (string | number)[];
            msg: string;
            type: string;
        }[];
        status: string;
    };
    VersionService: "all"
    | "api";
    WriteQueueInfo: {
        connection_url: string;
        exchange: string;
        queue: string;
        queue_publish_kwargs: {
            exchange: string;
            mandatory: boolean;
            properties: { delivery_mode: number };
            routing_key: string;
        };
    };
    WriteQueuePublishKwargs: {
        exchange: string;
        mandatory: boolean;
        properties: { delivery_mode: number };
        routing_key: string;
    };
    WriteQueuePublishProperties: { delivery_mode: number };
}

Type Declaration

AllowedFunctionsResponse: { endpoint_id: string; functions?: string[] | null; restricted: boolean }

AllowedFunctionsResponse
Example
```
{
         *       "endpoint_id": "7348422a-1074-427b-a08a-0771068afccc",
         *       "functions": [
         *         "063a3a9d-f40e-4b46-950a-fb24f75a345c",
         *         "e4b534c3-d9d0-47b0-8334-f52932ad3d9a",
         *         "ebe03b69-c966-42fb-ae3f-4a8c9e5b909e"
         *       ],
         *       "restricted": true
         *     }
```
- endpoint_id: string
  
  Endpoint Id Format: uuid
  
  Description
  Endpoint UUID
- Optionalfunctions?: string[] | null
  
  Functions
  
  Description
  The functions this endpoint is allowed to execute
- restricted: boolean
  
  Restricted
  
  Description
  False if the endpoint allows execution of any function. True if the endpoint will only execute functions from it's allowed list; see the functions field.

BatchStatusRequest: { task_ids: string[] }

BatchStatusRequest

Example

{
         *       "task_ids": [
         *         "7dac44aa-c480-4460-b453-a47b03b031f4",
         *         "4b35645f-0c5b-465d-aaec-fee87f74ff5b"
         *       ]
         *     }

task_ids: string[]

Task Ids

Description
Task UUIDs

BatchStatusResponse: {
    response: string;
    results: {
        [key: string]: {
            completion_t?: string | null;
            exception?: string | null;
            reason?: string | null;
            result?: string | null;
            status: unknown;
            task_id: string;
        };
    };
}

BatchStatusResponse

Example

{
         *       "response": "batch",
         *       "results": {
         *         "4b35645f-0c5b-465d-aaec-fee87f74ff5b": {
         *           "reason": "Task failed",
         *           "status": "failed",
         *           "task_id": "4b35645f-0c5b-465d-aaec-fee87f74ff5b"
         *         },
         *         "7dac44aa-c480-4460-b453-a47b03b031f4": {
         *           "completion_t": "1677183605.212898",
         *           "result": "10000",
         *           "status": "success",
         *           "task_id": "7dac44aa-c480-4460-b453-a47b03b031f4"
         *         }
         *       }
         *     }

response: string

Response

Description
Response
results: {
    [key: string]: {
        completion_t?: string | null;
        exception?: string | null;
        reason?: string | null;
        result?: string | null;
        status: unknown;
        task_id: string;
    };
}

Results

Description
Task results

BatchStatusResponseResults: {
    completion_t?: string | null;
    exception?: string | null;
    reason?: string | null;
    result?: string | null;
    status: unknown;
    task_id: string;
}

BatchStatusResponseResults
- Optionalcompletion_t?: string | null
  
  Completion T
  
  Description
  Task completion Unix time
- Optionalexception?: string | null
  
  Exception
  
  Description
  Exception
- Optionalreason?: string | null
  
  Reason
  
  Description
  Reason for exception
- Optionalresult?: string | null
  
  Result
  
  Description
  Task result
- status: unknown
  
  Status
  
  Description
  Task status
- task_id: string
  
  Task Id Format: uuid
  
  Description
  Task UUID
BatchSubmitResponseTask: {
    http_status_code: number;
    reason?: string | null;
    status: string;
    task_uuid: string;
}

BatchSubmitResponseTask
- http_status_code: number
  
  Http Status Code
  
  Description
  HTTP status code
- Optionalreason?: string | null
  
  Reason
  
  Description
  Reason for exception
- status: string
  
  Status
  
  Description
  Task status
- task_uuid: string
  
  Task Uuid Format: uuid
  
  Description
  Task UUID
BuildStatus:
    | "failed"
    | "provided"
    | "submitted"
    | "initialized"
    | "queued"
    | "building"
    | "ready"

BuildStatus
compute_web_service__schemas__v2__endpoint__EndpointLockResponse: { endpoint_id: string; lock_expiration_timestamp: string }

EndpointLockResponse
Example
```
{
         *       "endpoint_id": "7348422a-1074-427b-a08a-0771068afccc",
         *       "lock_expiration_timestamp": "2021-07-01T00:00:00.000000"
         *     }
```
- endpoint_id: string
  
  Endpoint Id Format: uuid
  
  Description
  Endpoint UUID
- lock_expiration_timestamp: string
  
  Lock Expiration Timestamp Format: date-time
  
  Description
  Lock expiration timestamp
compute_web_service__schemas__v2__endpoint__EndpointRegisterRequest: {
    allowed_functions?: string[] | null;
    authentication_policy?: string | null;
    display_name?: string | null;
    endpoint_name: string;
    endpoint_uuid: string;
    metadata?:
        | {
            config?: { [key: string]: unknown }
            | null;
            description?: string | null;
            endpoint_config?: string | null;
            endpoint_version?: string | null;
            hostname?: string | null;
            ip_address?: string | null;
            local_user?: string | null;
            python_version?: string | null;
            sdk_version?: string | null;
            user_config_schema?: { [key: string]: unknown } | null;
            user_config_template?: string | null;
        }
        | null;
    multi_user: boolean;
    version?: string
    | null;
}

EndpointRegisterRequest
Example
```
{
         *       "allowed_functions": [
         *         "11291b86-4f9c-47cb-848e-d3c06285951c"
         *       ],
         *       "authentication_policy": "67b4e120-2638-4771-86bb-6ac2a0f69e0b",
         *       "display_name": "My Endpoint's display name",
         *       "endpoint_name": "My Endpoint",
         *       "endpoint_uuid": "7348422a-1074-427b-a08a-0771068afccc",
         *       "metadata": {
         *         "description": "My endpoint description",
         *         "endpoint_config": "",
         *         "endpoint_version": "1.0.10",
         *         "hostname": "my-endpoint",
         *         "ip_address": "140.221.112.13",
         *         "local_user": "user",
         *         "python_version": "3.12.7",
         *         "sdk_version": "1.0.10",
         *         "user_config_schema": {},
         *         "user_config_template": {}
         *       },
         *       "multi_user": false,
         *       "version": "1.0.10"
         *     }
```
- Optionalallowed_functions?: string[] | null
  
  Allowed Functions
  
  Description
  Functions that are allowed to be run on the endpoint
- Optionalauthentication_policy?: string | null
  
  Authentication Policy
  
  Description
  Endpoint users are evaluated against this Globus authentication policy. For more information on Globus authentication policies, visit https://docs.globus.org/api/auth/developer-guide/#authentication-policies.
- Optionaldisplay_name?: string | null
  
  Display Name
  
  Description
  Endpoint display name
- endpoint_name: string
  
  Endpoint Name
  
  Description
  Endpoint name
- endpoint_uuid: string
  
  Endpoint Uuid Format: uuid
  
  Description
  Endpoint UUID
- Optionalmetadata?:
      | {
          config?: { [key: string]: unknown }
          | null;
          description?: string | null;
          endpoint_config?: string | null;
          endpoint_version?: string | null;
          hostname?: string | null;
          ip_address?: string | null;
          local_user?: string | null;
          python_version?: string | null;
          sdk_version?: string | null;
          user_config_schema?: { [key: string]: unknown } | null;
          user_config_template?: string | null;
      }
      | null
- multi_user: boolean
  
  Multi User
  Description
  Endpoint multi-user mode
  Default
```
false
```
- Optionalversion?: string | null
  
  Version
  
  Description
  Endpoint version
compute_web_service__schemas__v2__function__RegisterFunctionMetadata: { python_version?: string | null; sdk_version?: string | null }

RegisterFunctionMetadata
- Optionalpython_version?: string | null
  
  Python Version
  
  Description
  Python version used to serialize function.
- Optionalsdk_version?: string | null
  
  Sdk Version
  
  Description
  SDK version used to serialize function.
compute_web_service__schemas__v2__function__RegisterFunctionRequest: {
    container_uuid?: string | null;
    description?: string | null;
    entry_point?: string | null;
    function_code: string;
    function_name: string;
    group?: string | null;
    metadata?:
        | { python_version?: string
        | null; sdk_version?: string | null }
        | null;
    public: boolean;
}

RegisterFunctionRequest
Example
```
{
         *       "container_uuid": "b7a42fa2-e97f-4061-9e64-2ede22ae7f5e",
         *       "description": "My first function",
         *       "function_code": "wuX2RpbGyUjBBfY3JlYXRlX2Z1bmN0 ...",
         *       "function_name": "My Function",
         *       "group": "a2d6feb6-5386-4a06-8a22-99ea5ad7e651",
         *       "metadata": {
         *         "python_version": "3.11.3",
         *         "sdk_version": "2.3.3"
         *       },
         *       "public": false
         *     }
```
- Optionalcontainer_uuid?: string | null
  
  Container Uuid
  
  Description
  Container UUID
- Optionaldescription?: string | null
  
  Description
  
  Description
  Function description
- Optionalentry_point?: string | null
  
  Entry Point
  
  Description
  (DEPRECATED) Entry point
- function_code: string
  
  Function Code
  
  Description
  Serialized function source code
- function_name: string
  
  Function Name
  
  Description
  Function name
- Optionalgroup?: string | null
  
  Group
  
  Description
  Globus group UUID
- Optionalmetadata?: { python_version?: string | null; sdk_version?: string | null } | null
- public: boolean
  
  Public
  Description
  Public function
  Default
```
false
```
compute_web_service__schemas__v2__function__RegisterFunctionResponse: { function_uuid: string }

RegisterFunctionResponse
Example
```
{
         *       "function_uuid": "11291b86-4f9c-47cb-848e-d3c06285951c"
         *     }
```
- function_uuid: string
  
  Function Uuid Format: uuid
  
  Description
  Function UUID

compute_web_serviceschemasv2taskBatchSubmitRequest: {
    create_websocket_queue: boolean;
    task_group_id?: string | null;
    tasks: [string, string, string][];
}

BatchSubmitRequest

Example

{
         *       "create_websocket_queue": false,
         *       "task_group_id": "97241626-8ff4-4550-9938-5909bd221869",
         *       "tasks": [
         *         [
         *           "116f1b48-0aab-4228-92f0-021c2ab14b5e",
         *           "ff960aba-fa23-43d5-9cbe-3f4f91a066e1",
         *           "... <serialized_arguments> ..."
         *         ],
         *         [
         *           "116f1b48-0aab-4228-92f0-021c2ab14b5e",
         *           "ff960aba-fa23-43d5-9cbe-3f4f91a066e1",
         *           "... <serialized_arguments> ..."
         *         ]
         *       ]
         *     }

create_websocket_queue: boolean

Create Websocket Queue
Description
Create websocket queue
Default
```
true
```
Optionaltask_group_id?: string | null

Task Group Id

Description
Task group UUID
tasks: [string, string, string][]

Tasks

Description
List of tasks to invoke, each referencing function and endpoint UUIDs.

compute_web_serviceschemasv2taskBatchSubmitResponse: {
    response: string;
    results: (
        | string
        | {
            http_status_code: number;
            reason?: string
            | null;
            status: string;
            task_uuid: string;
        }
    )[];
    task_group_id?: string
    | null;
}

BatchSubmitResponse

Example

{
         *       "response": "success",
         *       "results": [
         *         {
         *           "http_status_code": 200,
         *           "status": "success",
         *           "task_uuid": "7dac44aa-c480-4460-b453-a47b03b031f4"
         *         },
         *         {
         *           "http_status_code": 200,
         *           "status": "success",
         *           "task_uuid": "4b35645f-0c5b-465d-aaec-fee87f74ff5b"
         *         }
         *       ],
         *       "task_group_id": "97241626-8ff4-4550-9938-5909bd221869"
         *     }

response: string

Response

Description
Response
results: (
    | string
    | {
        http_status_code: number;
        reason?: string
        | null;
        status: string;
        task_uuid: string;
    }
)[]

Results

Description
Task results
Optionaltask_group_id?: string | null

Task Group Id

Description
Task group UUID

compute_web_service__schemas__v3__endpoints__EndpointLockResponse: { endpoint_id: string; lock_expiration_timestamp: number }

EndpointLockResponse
Example
```
{
         *       "endpoint_id": "7348422a-1074-427b-a08a-0771068afccc",
         *       "lock_expiration_timestamp": "1687531403.0434475"
         *     }
```
- endpoint_id: string
  
  Endpoint Id Format: uuid
  
  Description
  Endpoint UUID
- lock_expiration_timestamp: number
  
  Lock Expiration Timestamp
  
  Description
  Lock expiration UNIX timestamp
compute_web_service__schemas__v3__endpoints__EndpointRegisterRequest: {
    admins?: string[] | null;
    allowed_functions?: string[] | null;
    authentication_policy?: string | null;
    display_name?: string | null;
    endpoint_name: string;
    high_assurance: boolean;
    metadata: {
        config?: { [key: string]: unknown } | null;
        description?: string | null;
        endpoint_config?: string | null;
        endpoint_version?: string | null;
        hostname?: string | null;
        ip_address?: string | null;
        local_user?: string | null;
        python_version?: string | null;
        sdk_version?: string | null;
        user_config_schema?: { [key: string]: unknown } | null;
        user_config_template?: string | null;
    };
    multi_user: boolean;
    public: boolean;
    subscription_uuid?: string
    | null;
    version?: string | null;
}

EndpointRegisterRequest
Example
```
{
         *       "allowed_functions": [
         *         "11291b86-4f9c-47cb-848e-d3c06285951c"
         *       ],
         *       "authentication_policy": "67b4e120-2638-4771-86bb-6ac2a0f69e0b",
         *       "display_name": "My Endpoint's Display Name",
         *       "endpoint_name": "my_endpoint",
         *       "high_assurance": false,
         *       "metadata": {
         *         "description": "My endpoint description",
         *         "endpoint_config": "",
         *         "endpoint_version": "2.2.0",
         *         "hostname": "my-endpoint",
         *         "ip_address": "140.221.112.13",
         *         "local_user": "user",
         *         "python_version": "3.12.7",
         *         "sdk_version": "2.2.0",
         *         "user_config_schema": {},
         *         "user_config_template": {}
         *       },
         *       "multi_user": false,
         *       "public": false,
         *       "subscription_uuid": "59b63c41-a765-4971-ac9a-41742059ade3",
         *       "version": "2.2.0"
         *     }
```
- Optionaladmins?: string[] | null
  
  Admins
  
  Description
  A set of Globus Auth identity IDs that, in addition to the owner, have administrative access to the endpoint. This field requires an active Globus subscription (i.e., subscription_uuid field).
- Optionalallowed_functions?: string[] | null
  
  Allowed Functions
  
  Description
  Functions that are allowed to be run on the endpoint
- Optionalauthentication_policy?: string | null
  
  Authentication Policy
  
  Description
  Endpoint users are evaluated against this Globus authentication policy. For more information on Globus authentication policies, visit https://docs.globus.org/api/auth/developer-guide/#authentication-policies.
- Optionaldisplay_name?: string | null
  
  Display Name
  
  Description
  Endpoint display name
- endpoint_name: string
  
  Endpoint Name
  
  Description
  Endpoint name
- high_assurance: boolean
  
  High Assurance
  Description
  Endpoint supports high-assurance protocols
  Default
```
false
```
- metadata: {
      config?: { [key: string]: unknown } | null;
      description?: string | null;
      endpoint_config?: string | null;
      endpoint_version?: string | null;
      hostname?: string | null;
      ip_address?: string | null;
      local_user?: string | null;
      python_version?: string | null;
      sdk_version?: string | null;
      user_config_schema?: { [key: string]: unknown } | null;
      user_config_template?: string | null;
  }
  
  Description
  Endpoint metadata
  - Optionalconfig?: { [key: string]: unknown } | null
    
    Config
    
    Deprecated
    
    Description
    This field is deprecated. Please use endpoint_config instead.
  - Optionaldescription?: string | null
    
    Description
    
    Description
    Endpoint description
  - Optionalendpoint_config?: string | null
    
    Endpoint Config
    
    Description
    The contents of the endpoint's configuration file (config.yaml).
  - Optionalendpoint_version?: string | null
    
    Endpoint Version
    
    Description
    Endpoint version
  - Optionalhostname?: string | null
    
    Hostname
    
    Description
    Endpoint hostname
  - Optionalip_address?: string | null
    
    Ip Address
    
    Description
    Endpoint IP address
  - Optionallocal_user?: string | null
    
    Local User
    
    Description
    Endpoint local user
  - Optionalpython_version?: string | null
    
    Python Version
    
    Description
    Endpoint Python version
  - Optionalsdk_version?: string | null
    
    Sdk Version
    
    Description
    Endpoint SDK version
  - Optionaluser_config_schema?: { [key: string]: unknown } | null
    
    User Config Schema
    
    Description
    User endpoint configuration schema
  - Optionaluser_config_template?: string | null
    
    User Config Template
    
    Description
    Multi-user endpoints will render this Jinja template with user-provided variables to generate a user-specific endpoint configuration.
- multi_user: boolean
  
  Multi User
  Description
  Endpoint multi-user mode
  Default
```
false
```
- public: boolean
  
  Public
  Description
  Indicates if all users can discover the multi-user endpoint. Please note that this field does not control access to the endpoint, so it should not be used as a security feature.
  Default
```
false
```
- Optionalsubscription_uuid?: string | null
  
  Subscription Uuid
  
  Description
  Associates an endpoint with a subscription.
- Optionalversion?: string | null
  
  Version
  
  Description
  Endpoint version
compute_web_service__schemas__v3__function__RegisterFunctionMetadata: { python_version: string; sdk_version: string; serde_identifier: string }

RegisterFunctionMetadata
- python_version: string
  
  Python Version
  
  Description
  version used to serialize function
- sdk_version: string
  
  Globus Compute SDK version
  
  Description
  version used to serialize function
- serde_identifier: string
  
  Serde Identifier
  
  Description
  Identifier of SDK method used to serialize the function; the identifiers are not currently specifically documented, but may be found in the Globus Compute SDK repository as the identifier class variable of the respective serializers
compute_web_service__schemas__v3__function__RegisterFunctionRequest: {
    description?: string | null;
    function_code: string;
    function_name: string;
    group?: string | null;
    ha_endpoint_id?: string | null;
    meta: {
        python_version: string;
        sdk_version: string;
        serde_identifier: string;
    };
    public: boolean;
}

RegisterFunctionRequest
Example
```
{
         *       "description": "Dot product of two vectors (unchecked length)",
         *       "function_code": "850\n01\ngASVZwIAAAAAAACMCmRpbGwuX2RpbGyUjBB...",
         *       "function_name": "dot_product",
         *       "meta": {
         *         "python_version": "3.13.3",
         *         "sdk_version": "3.1.1",
         *         "serde_identifier": "01"
         *       },
         *       "public": true
         *     }
```
- Optionaldescription?: string | null
  
  Description
  
  Description
  Function description
- function_code: string
  
  Function Code
  
  Description
  Serialized function source code
- function_name: string
  
  Function Name
  
  Description
  Function name
- Optionalgroup?: string | null
  
  Group
  
  Description
  If specified, this function will be accessible to members of the Globus Group specified by this identifier
- Optionalha_endpoint_id?: string | null
  
  Ha Endpoint Id
  
  Description
  Users will only be able to run this function on the specified HA endpoint. Since HA functions cannot be shared, this field is mutually exclusive with the group and public fields.
- meta: { python_version: string; sdk_version: string; serde_identifier: string }
  
  Description
  Function metadata
  - python_version: string
    
    Python Version
    
    Description
    version used to serialize function
  - sdk_version: string
    
    Globus Compute SDK version
    
    Description
    version used to serialize function
  - serde_identifier: string
    
    Serde Identifier
    
    Description
    Identifier of SDK method used to serialize the function; the identifiers are not currently specifically documented, but may be found in the Globus Compute SDK repository as the identifier class variable of the respective serializers
- public: boolean
  
  Public
  Description
  If true, this function will be accessible to any registered user
  Default
```
false
```
compute_web_service__schemas__v3__function__RegisterFunctionResponse: { function_uuid: string; ha_warning?: string | null }

RegisterFunctionResponse
Example
```
{
         *       "function_uuid": "11291b86-4f9c-47cb-848e-d3c06285951c"
         *     }
```
- function_uuid: string
  
  Function Uuid Format: uuid
  
  Description
  Function UUID
- Optionalha_warning?: string | null
  
  Ha Warning
  
  Description
  Populated when a function is registered to an HA endpoint. If present, the SDK will emit the text to the user as a warning.

compute_web_serviceschemasv3tasksBatchSubmitRequest: {
    create_queue: boolean;
    resource_specification?:
        | {
            launcher_options?: string
            | null;
            num_nodes: number;
            num_ranks?: number | null;
            ranks_per_node?: number | null;
        }
        | null;
    result_serializers?: string[]
    | null;
    task_group_id?: string | null;
    tasks: { [key: string]: string[] };
    user_endpoint_config?: { [key: string]: unknown } | null;
    user_runtime?:
        | {
            globus_compute_sdk_version?: string
            | null;
            globus_sdk_version?: string | null;
            platform?:
                | {
                    architecture?: [string, string]
                    | null;
                    machine?: string | null;
                    node?: string | null;
                    platform?: string | null;
                    processor?: string | null;
                    release?: string | null;
                }
                | null;
            python?: | {
                compiler?: string
                | null;
                implementation?: string | null;
                version?: string | null;
                version_description?: string | null;
                version_info?: [number, number, number, string, number] | null;
                version_tuple?: [number, number, number] | null;
            }
            | null;
            python_version?: string
            | null;
        }
        | null;
}

BatchSubmitRequest

Example

{
         *       "create_queue": true,
         *       "resource_specification": {
         *         "launcher_options": "--cpu-bind quiet --mem 3072",
         *         "num_nodes": 2,
         *         "num_ranks": 4,
         *         "ranks_per_node": 2
         *       },
         *       "result_serializers": [
         *         "globus_compute_sdk.serialize.JSONData",
         *         "globus_compute_sdk.serialize.DillDataBase64"
         *       ],
         *       "task_group_id": "97241626-8ff4-4550-9938-5909bd221869",
         *       "tasks": {
         *         "0a98fd06-edbd-11ed-abcd-0d705ebb4c49": [
         *           "... <serialized_arguments> ...",
         *           "..."
         *         ],
         *         "ff960aba-fa23-43d5-9cbe-3f4f91a066e1": [
         *           "... <serialized_arguments> ...",
         *           "... <serialized_arguments> ...",
         *           "..."
         *         ]
         *       },
         *       "user_endpoint_config": {
         *         "max_blocks": 1,
         *         "min_blocks": 0,
         *         "scheduler_options": "#SBATCH --constraint=knl,quad,cache"
         *       },
         *       "user_runtime": {
         *         "globus_compute_sdk_version": "3.14.0",
         *         "globus_sdk_version": "3.60.0",
         *         "platform": {
         *           "architecture": [
         *             "64bit",
         *             "ELF"
         *           ],
         *           "machine": "x86_64",
         *           "node": "login02",
         *           "platform": "Linux-6.16.5-2-generic-x86_64-with-glibc2.39",
         *           "processor": "x86_64",
         *           "release": "6.16.5-2-generic"
         *         },
         *         "python": {
         *           "compiler": "Clang 14.0.6",
         *           "implementation": "CPython",
         *           "version": "3.13.5",
         *           "version_description": "3.13.7 (main, Aug 21 2025, 13:50:03) [GCC 13.3.0]",
         *           "version_info": [
         *             3,
         *             13,
         *             5,
         *             "final",
         *             0
         *           ],
         *           "version_tuple": [
         *             3,
         *             13,
         *             5
         *           ]
         *         }
         *       }
         *     }

create_queue: boolean

Create Queue
Description
If true, create a Task Group specific AMQP queue for the results. In addition to the usual longer-term storage, results will also be copied to this AMQP queue, enabling consumers to get event-driven (instant) results. (See the Globus Compute SDK Executor for an implementation that uses this feature.)
Default
```
false
```
Optionalresource_specification?:
    | {
        launcher_options?: string
        | null;
        num_nodes: number;
        num_ranks?: number | null;
        ranks_per_node?: number | null;
    }
    | null

Description
Specify resource requirements for individual task execution.
Optionalresult_serializers?: string[] | null

Result Serializers

Description
A list of import paths to SerializationStrategy subclasses that the endpoint is allowed to use when serializing results.
Optionaltask_group_id?: string | null

Task Group Id

Description
Associate the request tasks with specified Task Group identifier; if not specified or invalid, a new identifier will be generated and returned in the response
tasks: { [key: string]: string[] }

Tasks

Description
Lists of serialized task arguments (strings), grouped by function identifiers
Optionaluser_endpoint_config?: { [key: string]: unknown } | null

User Endpoint Config

Description
Specify user endpoint configuration values as described and allowed by endpoint administrators.
Optionaluser_runtime?:
    | {
        globus_compute_sdk_version?: string
        | null;
        globus_sdk_version?: string | null;
        platform?:
            | {
                architecture?: [string, string]
                | null;
                machine?: string | null;
                node?: string | null;
                platform?: string | null;
                processor?: string | null;
                release?: string | null;
            }
            | null;
        python?: | {
            compiler?: string
            | null;
            implementation?: string | null;
            version?: string | null;
            version_description?: string | null;
            version_info?: [number, number, number, string, number] | null;
            version_tuple?: [number, number, number] | null;
        }
        | null;
        python_version?: string
        | null;
    }
    | null

Description
Information about the runtime that submitted this batch, such as Python and Globus Compute SDK versions.

compute_web_service__schemas__v3__tasks__BatchSubmitResponse: {
    endpoint_id: string;
    ha_warning?: string | null;
    request_id: string;
    task_group_id: string;
    tasks: { [key: string]: string[] };
}

BatchSubmitResponse
Example
```
{
         *       "endpoint_id": "116f1b48-0aab-4228-92f0-021c2ab14b5e",
         *       "request_id": "5158de19-10b5-4deb-9d87-a86c1dec3460",
         *       "task_group_id": "97241626-8ff4-4550-9938-5909bd221869",
         *       "tasks": {
         *         "0a98fd06-edbd-11ed-abcd-0d705ebb4c49": [
         *           "022151bf-7b2d-4240-b4d0-9ac5b7077314",
         *           "1f6f5f1e-15b0-4916-85ff-471511bd35d6"
         *         ],
         *         "ff960aba-fa23-43d5-9cbe-3f4f91a066e1": [
         *           "89bde6c3-85e9-4834-b0e8-5cb51955eaf5",
         *           "1e900b37-7a80-424b-aeac-56dd2860f59a",
         *           "9f12a732-3aa6-4878-9d58-b290837ab096"
         *         ]
         *       }
         *     }
```
- endpoint_id: string
  
  Endpoint Id Format: uuid
  
  Description
  The endpoint to which the request's tasks were sent for invocation
- Optionalha_warning?: string | null
  
  Ha Warning
  
  Description
  Populated when a task is submitted to an HA endpoint. If present, the SDK will emit the text to the user as a warning.
- request_id: string
  
  Request Id
  
  Description
  A unique string to identify the request; currently this is mainly to aid debugging efforts — such as if a user needs to verify an interaction with Globus Support — and has no automated API hookup or use elsewhere in the Compute ecosystem
- task_group_id: string
  
  Task Group Id Format: uuid
  
  Description
  The Task Group identifier to which the submitted tasks were associated
- tasks: { [key: string]: string[] }
  
  Tasks
  
  Description
  The task identifiers, grouped by the identifier of the function IDs that will execute them. Note that the order of the identifiers within each list exactly matches the order of serialized arguments in the request.
ComputeVersionResponse: {
    api: string;
    container_service?: string | null;
    git_sha?: string | null;
    min_ep_version?: string | null;
    min_sdk_version?: string | null;
}

ComputeVersionResponse
Example
```
{
         *       "api": "1.0.9",
         *       "container_service": "0.0.1",
         *       "git_sha": "3ae0ff6bc42b6d5f9d92f3c426fe9e535a841hb6",
         *       "min_ep_version": "1.0.10",
         *       "min_sdk_version": "1.0.10"
         *     }
```
- api: string
  
  Api
  
  Description
  API version
- Optionalcontainer_service?: string | null
  
  Container Service
  
  Description
  Container service version
- Optionalgit_sha?: string | null
  
  Git Sha
  
  Description
  Git SHA of the latest commit
- Optionalmin_ep_version?: string | null
  
  Min Ep Version
  
  Description
  Minimum endpoint version
- Optionalmin_sdk_version?: string | null
  
  Min Sdk Version
  
  Description
  Minimum SDK version
ConsoleNodeInfo: {
    endpoint_version?: string | null;
    idle_duration_seconds?: number | null;
    python_version?: string | null;
    sdk_version?: string | null;
    total_worker_count?: number | null;
}

ConsoleNodeInfo
- Optionalendpoint_version?: string | null
  
  Endpoint Version
  
  Description
  Version of globus-compute-endpoint running on the node
- Optionalidle_duration_seconds?: number | null
  
  Idle Duration Seconds
  
  Description
  Idle duration in seconds
- Optionalpython_version?: string | null
  
  Python Version
  
  Description
  Node Python version
- Optionalsdk_version?: string | null
  
  Sdk Version
  
  Description
  Version of globus-compute-sdk running on the node
- Optionaltotal_worker_count?: number | null
  
  Total Worker Count
  
  Description
  Total number of provisioned workers on the node

ConsoleResponse: {
    user_endpoints: {
        account?: string | null;
        active: boolean;
        client_sdk_versions?: string[];
        config?: string | null;
        endpoint_version?: string | null;
        engine_type?: string | null;
        executed_task_count?: number | null;
        idle_worker_count?: number | null;
        last_heartbeat_unix?: number | null;
        node_info?:
            | {
                [key: string]: {
                    endpoint_version?: string
                    | null;
                    idle_duration_seconds?: number | null;
                    python_version?: string | null;
                    sdk_version?: string | null;
                    total_worker_count?: number | null;
                }[];
            }
            | null;
        posix_pid?: number
        | null;
        posix_username?: string | null;
        provider_type?: string | null;
        python_version?: string | null;
        queue?: string | null;
        queued_task_count?: number | null;
        running_task_count?: number | null;
        start_time_iso?: string | null;
        start_time_unix?: number | null;
        total_node_count?: number | null;
        total_worker_count?: number | null;
        user_endpoint_id: string;
    }[];
}

ConsoleResponse

Example

{
         *       "user_endpoints": [
         *         {
         *           "account": "my-slurm-account",
         *           "active": true,
         *           "config": "engine:\n  type: GlobusComputeEngine\n  max_workers_per_node: 2\n  provider:\n    type: SlurmProvider\n    account: my-slurm-account\n    partition: caslake\n    worker_init: 'module load Anaconda; source activate compute-env'\n    nodes_per_block: 1\n    max_blocks: 1\n  address:\n    type: address_by_interface\n    ifname: bond0\n",
         *           "endpoint_version": "3.1.1",
         *           "engine_type": "GlobusComputeEngine",
         *           "executed_task_count": 15,
         *           "idle_worker_count": 0,
         *           "last_heartbeat_unix": 1735884207.498273,
         *           "node_info": {
         *             "some_job_id": [
         *               {
         *                 "endpoint_version": "3.1.1",
         *                 "idle_duration_seconds": 0,
         *                 "python_version": "3.12.7",
         *                 "sdk_version": "3.1.1",
         *                 "total_worker_count": 2
         *               }
         *             ]
         *           },
         *           "posix_pid": 12345,
         *           "posix_username": "test_user",
         *           "provider_type": "SlurmProvider",
         *           "python_version": "3.12.7",
         *           "queue": "caslake",
         *           "queued_task_count": 0,
         *           "running_task_count": 3,
         *           "start_time_iso": "2025-01-02T21:20:19.123456-05:00",
         *           "start_time_unix": 1735870819.123456,
         *           "total_node_count": 1,
         *           "total_worker_count": 2,
         *           "user_endpoint_id": "7348422a-1074-427b-a08a-0771068afccc"
         *         }
         *       ]
         *     }

user_endpoints: {
    account?: string | null;
    active: boolean;
    client_sdk_versions?: string[];
    config?: string | null;
    endpoint_version?: string | null;
    engine_type?: string | null;
    executed_task_count?: number | null;
    idle_worker_count?: number | null;
    last_heartbeat_unix?: number | null;
    node_info?:
        | {
            [key: string]: {
                endpoint_version?: string
                | null;
                idle_duration_seconds?: number | null;
                python_version?: string | null;
                sdk_version?: string | null;
                total_worker_count?: number | null;
            }[];
        }
        | null;
    posix_pid?: number
    | null;
    posix_username?: string | null;
    provider_type?: string | null;
    python_version?: string | null;
    queue?: string | null;
    queued_task_count?: number | null;
    running_task_count?: number | null;
    start_time_iso?: string | null;
    start_time_unix?: number | null;
    total_node_count?: number | null;
    total_worker_count?: number | null;
    user_endpoint_id: string;
}[]

User Endpoints

Description
List of information about each running user endpoint process

ConsoleUserEndpointInfo: {
    account?: string | null;
    active: boolean;
    client_sdk_versions?: string[];
    config?: string | null;
    endpoint_version?: string | null;
    engine_type?: string | null;
    executed_task_count?: number | null;
    idle_worker_count?: number | null;
    last_heartbeat_unix?: number | null;
    node_info?:
        | {
            [key: string]: {
                endpoint_version?: string
                | null;
                idle_duration_seconds?: number | null;
                python_version?: string | null;
                sdk_version?: string | null;
                total_worker_count?: number | null;
            }[];
        }
        | null;
    posix_pid?: number
    | null;
    posix_username?: string | null;
    provider_type?: string | null;
    python_version?: string | null;
    queue?: string | null;
    queued_task_count?: number | null;
    running_task_count?: number | null;
    start_time_iso?: string | null;
    start_time_unix?: number | null;
    total_node_count?: number | null;
    total_worker_count?: number | null;
    user_endpoint_id: string;
}

ConsoleUserEndpointInfo
- Optionalaccount?: string | null
  
  Account
  
  Description
  The account against which the scheduler charges resources that are consumed by the user endpoint
- active: boolean
  
  Active
  Description
  Whether the user endpoint is active
  Default
```
true
```
- Optionalclient_sdk_versions?: string[]
  
  Client Sdk Versions
  
  Description
  SDK versions used to submit tasks to the user endpoint
- Optionalconfig?: string | null
  
  Config
  
  Description
  User endpoint configuration YAML content. We do not include this field by default because it may be quite large. Users must explicitly request it using the include_fields query parameter.
- Optionalendpoint_version?: string | null
  
  Endpoint Version
  
  Description
  User endpoint version
- Optionalengine_type?: string | null
  
  Engine Type
  
  Description
  User endpoint engine type. See our documentation for more information: https://globus-compute.readthedocs.io/en/latest/endpoints/config_reference.html#user-endpoint-configuration
- Optionalexecuted_task_count?: number | null
  
  Executed Task Count
  
  Description
  Number of executed tasks
- Optionalidle_worker_count?: number | null
  
  Idle Worker Count
  
  Description
  Number of idle workers
- Optionallast_heartbeat_unix?: number | null
  
  Last Heartbeat Unix
  
  Description
  UNIX timestamp indicating when the services last processed a heartbeat for the user endpoint
- Optionalnode_info?:
      | {
          [key: string]: {
              endpoint_version?: string
              | null;
              idle_duration_seconds?: number | null;
              python_version?: string | null;
              sdk_version?: string | null;
              total_worker_count?: number | null;
          }[];
      }
      | null
  
  Node Info
  
  Description
  Details for each provisioned node, indexed by job ID
- Optionalposix_pid?: number | null
  
  Posix Pid
  
  Description
  User endpoint process ID
- Optionalposix_username?: string | null
  
  Posix Username
  
  Description
  Local POSIX user running the user endpoint
- Optionalprovider_type?: string | null
  
  Provider Type
  
  Description
  User endpoint provider type. See our documentation for more information: https://globus-compute.readthedocs.io/en/latest/endpoints/config_reference.html#user-endpoint-configuration
- Optionalpython_version?: string | null
  
  Python Version
  
  Description
  User endpoint Python version
- Optionalqueue?: string | null
  
  Queue
  
  Description
  The scheduler queue to which the user endpoint will submit jobs
- Optionalqueued_task_count?: number | null
  
  Queued Task Count
  
  Description
  Number of queued tasks
- Optionalrunning_task_count?: number | null
  
  Running Task Count
  
  Description
  Number of running tasks
- Optionalstart_time_iso?: string | null
  
  Start Time Iso
  
  Description
  User endpoint start time in ISO format including timezone offset
- Optionalstart_time_unix?: number | null
  
  Start Time Unix
  
  Description
  UNIX timestamp indicating when the user endpoint was started
- Optionaltotal_node_count?: number | null
  
  Total Node Count
  
  Description
  Total number of provisioned nodes
- Optionaltotal_worker_count?: number | null
  
  Total Worker Count
  
  Description
  Total number of provisioned workers
- user_endpoint_id: string
  
  User Endpoint Id Format: uuid
  
  Description
  User endpoint UUID (key identifier)

ContainerBuildRequest: {
    apt: string[];
    conda: string[];
    description?: string | null;
    name: string;
    payload_url?: string | null;
    pip: string[];
}

ContainerBuildRequest

Example

{
         *       "apt": [
         *         "vim",
         *         "git"
         *       ],
         *       "conda": [],
         *       "description": "Container with vim and git installed using apt and numpy and pandas installed using pip.",
         *       "name": "My Container",
         *       "payload_url": "https://github.com/my-container",
         *       "pip": [
         *         "numpy",
         *         "pandas"
         *       ]
         *     }

apt: string[]

Apt

Description
Optional list of package names to be installed via apt-get
conda: string[]

Conda

Description
Optional list of conda requirements (name and optional version specifier)
Optionaldescription?: string | null

Description

Description
Long container description
name: string

Name

Description
Container name
Optionalpayload_url?: string | null

Payload Url

Description
URL to GitHub repo or publicly readable zip file
pip: string[]

Pip

Description
Optional list of pip requirements (name and optional version specifier)

ContainerBuildResponse: { container_id: string }

ContainerBuildResponse
Example
```
{
         *       "container_id": "b7a42fa2-e97f-4061-9e64-2ede22ae7f5e"
         *     }
```
- container_id: string
  
  Container Id Format: uuid
  
  Description
  Container UUID
ContainerBuildStatusResponse: {
    status:
        | "failed"
        | "provided"
        | "submitted"
        | "initialized"
        | "queued"
        | "building"
        | "ready";
}

ContainerBuildStatusResponse
Example
```
{
         *       "status": "ready"
         *     }
```
- status:
      | "failed"
      | "provided"
      | "submitted"
      | "initialized"
      | "queued"
      | "building"
      | "ready"
  
  Description
  Container build status
ContainerRegisterRequest: {
    description?: string | null;
    location: string;
    name: string;
    type: "docker" | "singularity";
}

ContainerRegisterRequest
Example
```
{
         *       "description": "My container description",
         *       "location": "docker://my-container:latest",
         *       "name": "My Container",
         *       "type": "docker"
         *     }
```
- Optionaldescription?: string | null
  
  Description
  
  Description
  Long container description
- location: string
  
  Location
  
  Description
  The location of the container (e.g., its docker url)
- name: string
  
  Name
  
  Description
  Container name
- type: "docker" | "singularity"
ContainerRegisterResponse: { container_id: string }

ContainerRegisterResponse
Example
```
{
         *       "container_id": "b7a42fa2-e97f-4061-9e64-2ede22ae7f5e"
         *     }
```
- container_id: string
  
  Container Id Format: uuid
  
  Description
  Container UUID
ContainerRuntime: "docker" | "singularity"

ContainerRuntime

Description
Runtime to be used to execute the container.
ContainerStatus: {
    build_status:
        | "failed"
        | "provided"
        | "submitted"
        | "initialized"
        | "queued"
        | "building"
        | "ready";
    build_stderr?: string
    | null;
    container_uuid: string;
    err_message?: string | null;
    location?: string | null;
    name: string;
    type?: "docker" | "singularity" | null;
}

ContainerStatus
- build_status:
      | "failed"
      | "provided"
      | "submitted"
      | "initialized"
      | "queued"
      | "building"
      | "ready"
  
  Description
  Container build status
- Optionalbuild_stderr?: string | null
  
  Build Stderr
  
  Description
  Container build stderr
- container_uuid: string
  
  Container Uuid Format: uuid
  
  Description
  Container UUID
- Optionalerr_message?: string | null
  
  Err Message
  
  Description
  Container error message
- Optionallocation?: string | null
  
  Location
  
  Description
  Container location
- name: string
  
  Name
  
  Description
  Container name
- Optionaltype?: "docker" | "singularity" | null
ContainerStatusResponse: {
    container: {
        build_status:
            | "failed"
            | "provided"
            | "submitted"
            | "initialized"
            | "queued"
            | "building"
            | "ready";
        build_stderr?: string
        | null;
        container_uuid: string;
        err_message?: string | null;
        location?: string | null;
        name: string;
        type?: "docker" | "singularity" | null;
    };
}

ContainerStatusResponse
Example
```
{
         *       "container": {
         *         "build_status": "ready",
         *         "container_uuid": "b7a42fa2-e97f-4061-9e64-2ede22ae7f5e",
         *         "location": "docker://my-container:latest",
         *         "name": "My Container",
         *         "type": "docker"
         *       }
         *     }
```
- container: {
      build_status:
          | "failed"
          | "provided"
          | "submitted"
          | "initialized"
          | "queued"
          | "building"
          | "ready";
      build_stderr?: string
      | null;
      container_uuid: string;
      err_message?: string | null;
      location?: string | null;
      name: string;
      type?: "docker" | "singularity" | null;
  }
  - build_status:
        | "failed"
        | "provided"
        | "submitted"
        | "initialized"
        | "queued"
        | "building"
        | "ready"
    
    Description
    Container build status
  - Optionalbuild_stderr?: string | null
    
    Build Stderr
    
    Description
    Container build stderr
  - container_uuid: string
    
    Container Uuid Format: uuid
    
    Description
    Container UUID
  - Optionalerr_message?: string | null
    
    Err Message
    
    Description
    Container error message
  - Optionallocation?: string | null
    
    Location
    
    Description
    Container location
  - name: string
    
    Name
    
    Description
    Container name
  - Optionaltype?: "docker" | "singularity" | null
DeleteFunctionResponse: { result: number }

DeleteFunctionResponse
Example
```
{
         *       "result": 302
         *     }
```
- result: number
  
  Result
  
  Description
  The result as a status code integer
Endpoint: {
    config?: { [key: string]: unknown } | null;
    description?: string | null;
    display_name: string;
    endpoint_config?: string | null;
    endpoint_version?: string | null;
    high_assurance: boolean;
    hostname?: string | null;
    ip_address?: string | null;
    local_user?: string | null;
    multi_user: boolean;
    name: string;
    public: boolean;
    python_version?: string | null;
    sdk_version?: string | null;
    subscription_admin_verified: boolean;
    subscription_uuid?: string | null;
    user_config_schema?: { [key: string]: unknown } | null;
    user_config_template?: string | null;
    uuid: string;
}

Endpoint
Example
```
{
         *       "description": "My endpoint description",
         *       "display_name": "My Endpoint's display name",
         *       "endpoint_config": "",
         *       "endpoint_version": "1.0.10",
         *       "high_assurance": false,
         *       "hostname": "my-endpoint",
         *       "ip_address": "140.221.112.13",
         *       "local_user": "user",
         *       "multi_user": false,
         *       "name": "My Endpoint",
         *       "public": false,
         *       "python_version": "3.12.7",
         *       "sdk_version": "1.0.10",
         *       "subscription_admin_verified": false,
         *       "subscription_uuid": "b0b7b089-707a-4d90-a036-05b7964d6b60",
         *       "user_config_schema": {},
         *       "user_config_template": {},
         *       "uuid": "7348422a-1074-427b-a08a-0771068afccc"
         *     }
```
- Optionalconfig?: { [key: string]: unknown } | null
  
  Config
  
  Deprecated
  
  Description
  This field is deprecated. Please use endpoint_config instead.
- Optionaldescription?: string | null
  
  Description
  
  Description
  Endpoint description
- display_name: string
  
  Display Name
  
  Description
  Display name
- Optionalendpoint_config?: string | null
  
  Endpoint Config
  
  Description
  The contents of the endpoint's configuration file (config.yaml).
- Optionalendpoint_version?: string | null
  
  Endpoint Version
  
  Description
  Endpoint version
- high_assurance: boolean
  
  High Assurance
  
  Description
  Endpoint supports high-assurance protocols
- Optionalhostname?: string | null
  
  Hostname
  
  Description
  Endpoint hostname
- Optionalip_address?: string | null
  
  Ip Address
  
  Description
  Endpoint IP address
- Optionallocal_user?: string | null
  
  Local User
  
  Description
  Endpoint local user
- multi_user: boolean
  
  Multi User
  
  Description
  Endpoint multi-user mode
- name: string
  
  Name
  
  Description
  Endpoint name
- public: boolean
  
  Public
  
  Description
  Indicates if all users can discover the multi-user endpoint.
- Optionalpython_version?: string | null
  
  Python Version
  
  Description
  Endpoint Python version
- Optionalsdk_version?: string | null
  
  Sdk Version
  
  Description
  Endpoint SDK version
- subscription_admin_verified: boolean
  
  Subscription Admin Verified
  Description
  Indicates that the endpoint has been verified as a valid organizational resource by a Globus subscription administrator.
  Default
```
false
```
- Optionalsubscription_uuid?: string | null
  
  Subscription Uuid
  
  Description
  Globus subscription UUID
- Optionaluser_config_schema?: { [key: string]: unknown } | null
  
  User Config Schema
  
  Description
  User endpoint configuration schema
- Optionaluser_config_template?: string | null
  
  User Config Template
  
  Description
  Multi-user endpoints will render this Jinja template with user-provided variables to generate a user-specific endpoint configuration.
- uuid: string
  
  Uuid Format: uuid
  
  Description
  Endpoint UUID
EndpointConfig: {
    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[]
    | null;
}

EndpointConfig
Example
```
{
         *       "endpoint_id": "7348422a-1074-427b-a08a-0771068afccc",
         *       "result_queue_info": {
         *         "connection_url": "amqps://user:password@mq.fqdn",
         *         "exchange": "some_exchange",
         *         "queue": "some_queue",
         *         "queue_publish_kwargs": {
         *           "exchange": "some_exchange",
         *           "mandatory": true,
         *           "properties": {
         *             "delivery_mode": 2
         *           },
         *           "routing_key": "some_key"
         *         }
         *       },
         *       "task_queue_info": {
         *         "connection_url": "amqps://user:password@mq.fqdn",
         *         "exchange": "some_exchange",
         *         "queue": "some_queue"
         *       },
         *       "warnings": []
         *     }
```
- endpoint_id: string
  
  Endpoint Id Format: uuid
  
  Description
  Endpoint UUID
- result_queue_info: {
      connection_url: string;
      exchange: string;
      queue: string;
      queue_publish_kwargs: {
          exchange: string;
          mandatory: boolean;
          properties: { delivery_mode: number };
          routing_key: string;
      };
  }
  - connection_url: string
    
    Connection Url
    
    Description
    Connection URL
  - exchange: string
    
    Exchange
    
    Description
    Exchange
  - queue: string
    
    Queue
    
    Description
    Queue
  - queue_publish_kwargs: {
        exchange: string;
        mandatory: boolean;
        properties: { delivery_mode: number };
        routing_key: string;
    }
    - exchange: string
      
      Exchange
      
      Description
      Exchange
    - mandatory: boolean
      
      Mandatory
      
      Description
      Mandatory
    - properties: { delivery_mode: number }
      - delivery_mode: number
        
        Delivery Mode
        
        Description
        Delivery mode
    - routing_key: string
      
      Routing Key
      
      Description
      Routing key
- task_queue_info: { connection_url: string; exchange: string; queue: string }
  - connection_url: string
    
    Connection Url
    
    Description
    Connection URL
  - exchange: string
    
    Exchange
    
    Description
    Exchange
  - queue: string
    
    Queue
    
    Description
    Queue
- Optionalwarnings?: string[] | null
  
  Warnings
  
  Description
  Warnings
EndpointConfigQueueInfo: { connection_url: string; exchange: string; queue: string }

EndpointConfigQueueInfo
- connection_url: string
  
  Connection Url
  
  Description
  Connection URL
- exchange: string
  
  Exchange
  
  Description
  Exchange
- queue: string
  
  Queue
  
  Description
  Queue
EndpointConfigResultQueue: {
    connection_url: string;
    exchange: string;
    queue: string;
    queue_publish_kwargs: {
        exchange: string;
        mandatory: boolean;
        properties: { delivery_mode: number };
        routing_key: string;
    };
}

EndpointConfigResultQueue
- connection_url: string
  
  Connection Url
  
  Description
  Connection URL
- exchange: string
  
  Exchange
  
  Description
  Exchange
- queue: string
  
  Queue
  
  Description
  Queue
- queue_publish_kwargs: {
      exchange: string;
      mandatory: boolean;
      properties: { delivery_mode: number };
      routing_key: string;
  }
  - exchange: string
    
    Exchange
    
    Description
    Exchange
  - mandatory: boolean
    
    Mandatory
    
    Description
    Mandatory
  - properties: { delivery_mode: number }
    - delivery_mode: number
      
      Delivery Mode
      
      Description
      Delivery mode
  - routing_key: string
    
    Routing Key
    
    Description
    Routing key
EndpointConfigResultQueuePublish: {
    exchange: string;
    mandatory: boolean;
    properties: { delivery_mode: number };
    routing_key: string;
}

EndpointConfigResultQueuePublish
- exchange: string
  
  Exchange
  
  Description
  Exchange
- mandatory: boolean
  
  Mandatory
  
  Description
  Mandatory
- properties: { delivery_mode: number }
  - delivery_mode: number
    
    Delivery Mode
    
    Description
    Delivery mode
- routing_key: string
  
  Routing Key
  
  Description
  Routing key
EndpointConfigResultQueuePublishProperties: { delivery_mode: number }

EndpointConfigResultQueuePublishProperties
- delivery_mode: number
  
  Delivery Mode
  
  Description
  Delivery mode
EndpointDeleteResponse: { result: number }

EndpointDeleteResponse
Example
```
{
         *       "result": 302
         *     }
```
- result: number
  
  Result
  
  Description
  The result as a status code integer
EndpointListResponseEntry: { display_name: string; name: string; owner: string; uuid: string }

EndpointListResponseEntry
Example
```
{
         *       "display_name": "My Endpoint's display name",
         *       "name": "My Endpoint",
         *       "owner": "0b3390f4-ca5f-496d-a7b9-9e4faed46bff",
         *       "uuid": "7348422a-1074-427b-a08a-0771068afccc"
         *     }
```
- display_name: string
  
  Display Name
  
  Description
  Display name
- name: string
  
  Name
  
  Description
  Endpoint name
- owner: string
  
  Owner Format: uuid
  
  Description
  Endpoint owner's identity ID
- uuid: string
  
  Uuid Format: uuid
  
  Description
  Endpoint UUID
EndpointMetadata: {
    config?: { [key: string]: unknown } | null;
    description?: string | null;
    endpoint_config?: string | null;
    endpoint_version?: string | null;
    hostname?: string | null;
    ip_address?: string | null;
    local_user?: string | null;
    python_version?: string | null;
    sdk_version?: string | null;
    user_config_schema?: { [key: string]: unknown } | null;
    user_config_template?: string | null;
}

EndpointMetadata
- Optionalconfig?: { [key: string]: unknown } | null
  
  Config
  
  Deprecated
  
  Description
  This field is deprecated. Please use endpoint_config instead.
- Optionaldescription?: string | null
  
  Description
  
  Description
  Endpoint description
- Optionalendpoint_config?: string | null
  
  Endpoint Config
  
  Description
  The contents of the endpoint's configuration file (config.yaml).
- Optionalendpoint_version?: string | null
  
  Endpoint Version
  
  Description
  Endpoint version
- Optionalhostname?: string | null
  
  Hostname
  
  Description
  Endpoint hostname
- Optionalip_address?: string | null
  
  Ip Address
  
  Description
  Endpoint IP address
- Optionallocal_user?: string | null
  
  Local User
  
  Description
  Endpoint local user
- Optionalpython_version?: string | null
  
  Python Version
  
  Description
  Endpoint Python version
- Optionalsdk_version?: string | null
  
  Sdk Version
  
  Description
  Endpoint SDK version
- Optionaluser_config_schema?: { [key: string]: unknown } | null
  
  User Config Schema
  
  Description
  User endpoint configuration schema
- Optionaluser_config_template?: string | null
  
  User Config Template
  
  Description
  Multi-user endpoints will render this Jinja template with user-provided variables to generate a user-specific endpoint configuration.
EndpointRegisterMetadata: {
    config?: { [key: string]: unknown } | null;
    description?: string | null;
    endpoint_config?: string | null;
    endpoint_version?: string | null;
    hostname?: string | null;
    ip_address?: string | null;
    local_user?: string | null;
    python_version?: string | null;
    sdk_version?: string | null;
    user_config_schema?: { [key: string]: unknown } | null;
    user_config_template?: string | null;
}

EndpointRegisterMetadata
- Optionalconfig?: { [key: string]: unknown } | null
  
  Config
  
  Deprecated
  
  Description
  This field is deprecated. Please use endpoint_config instead.
- Optionaldescription?: string | null
  
  Description
  
  Description
  Endpoint description
- Optionalendpoint_config?: string | null
  
  Endpoint Config
  
  Description
  The contents of the endpoint's configuration file (config.yaml).
- Optionalendpoint_version?: string | null
  
  Endpoint Version
  
  Description
  Endpoint version
- Optionalhostname?: string | null
  
  Hostname
  
  Description
  Endpoint hostname
- Optionalip_address?: string | null
  
  Ip Address
  
  Description
  Endpoint IP address
- Optionallocal_user?: string | null
  
  Local User
  
  Description
  Endpoint local user
- Optionalpython_version?: string | null
  
  Python Version
  
  Description
  Endpoint Python version
- Optionalsdk_version?: string | null
  
  Sdk Version
  
  Description
  Endpoint SDK version
- Optionaluser_config_schema?: { [key: string]: unknown } | null
  
  User Config Schema
  
  Description
  User endpoint configuration schema
- Optionaluser_config_template?: string | null
  
  User Config Template
  
  Description
  Multi-user endpoints will render this Jinja template with user-provided variables to generate a user-specific endpoint configuration.
EndpointRegisterResponse: {
    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[]
    | null;
}

EndpointRegisterResponse
Example
```
{
         *       "endpoint_id": "7348422a-1074-427b-a08a-0771068afccc",
         *       "heartbeat_queue_info": {
         *         "connection_url": "amqps://user:password@mq.fqdn",
         *         "exchange": "some_exchange",
         *         "queue": "some_queue",
         *         "queue_publish_kwargs": {
         *           "exchange": "some_exchange",
         *           "mandatory": true,
         *           "properties": {
         *             "delivery_mode": 2
         *           },
         *           "routing_key": "some_key"
         *         }
         *       },
         *       "result_queue_info": {
         *         "connection_url": "amqps://user:password@mq.fqdn",
         *         "exchange": "some_exchange",
         *         "queue": "some_queue",
         *         "queue_publish_kwargs": {
         *           "exchange": "some_exchange",
         *           "mandatory": true,
         *           "properties": {
         *             "delivery_mode": 2
         *           },
         *           "routing_key": "some_key"
         *         }
         *       },
         *       "task_queue_info": {
         *         "connection_url": "amqps://user:password@mq.fqdn",
         *         "exchange": "some_exchange",
         *         "queue": "some_queue"
         *       }
         *     }
```
- endpoint_id: string
  
  Endpoint Id Format: uuid
  
  Description
  Endpoint UUID
- heartbeat_queue_info: {
      connection_url: string;
      exchange: string;
      queue: string;
      queue_publish_kwargs: {
          exchange: string;
          mandatory: boolean;
          properties: { delivery_mode: number };
          routing_key: string;
      };
  }
  - connection_url: string
    
    Connection Url
    
    Description
    Connection URL
  - exchange: string
    
    Exchange
    
    Description
    Exchange
  - queue: string
    
    Queue
    
    Description
    Queue
  - queue_publish_kwargs: {
        exchange: string;
        mandatory: boolean;
        properties: { delivery_mode: number };
        routing_key: string;
    }
    - exchange: string
      
      Exchange
      
      Description
      Exchange
    - mandatory: boolean
      
      Mandatory
      
      Description
      Mandatory
    - properties: { delivery_mode: number }
      - delivery_mode: number
        
        Delivery Mode
        
        Description
        Delivery mode
    - routing_key: string
      
      Routing Key
      
      Description
      Routing key
- result_queue_info: {
      connection_url: string;
      exchange: string;
      queue: string;
      queue_publish_kwargs: {
          exchange: string;
          mandatory: boolean;
          properties: { delivery_mode: number };
          routing_key: string;
      };
  }
  - connection_url: string
    
    Connection Url
    
    Description
    Connection URL
  - exchange: string
    
    Exchange
    
    Description
    Exchange
  - queue: string
    
    Queue
    
    Description
    Queue
  - queue_publish_kwargs: {
        exchange: string;
        mandatory: boolean;
        properties: { delivery_mode: number };
        routing_key: string;
    }
    - exchange: string
      
      Exchange
      
      Description
      Exchange
    - mandatory: boolean
      
      Mandatory
      
      Description
      Mandatory
    - properties: { delivery_mode: number }
      - delivery_mode: number
        
        Delivery Mode
        
        Description
        Delivery mode
    - routing_key: string
      
      Routing Key
      
      Description
      Routing key
- task_queue_info: { connection_url: string; exchange: string; queue: string }
  - connection_url: string
    
    Connection Url
    
    Description
    Connection URL
  - exchange: string
    
    Exchange
    
    Description
    Exchange
  - queue: string
    
    Queue
    
    Description
    Queue
- Optionalwarnings?: string[] | null
  
  Warnings
  
  Description
  Warnings
EndpointStatusDetails: {
    idle_workers: number | "NaN" | "Infinity" | "-Infinity";
    managers?: number | "NaN" | "Infinity" | "-Infinity" | null;
    outstanding_tasks: number | "NaN" | "Infinity" | "-Infinity";
    pending_tasks: number | "NaN" | "Infinity" | "-Infinity";
    total_workers: number | "NaN" | "Infinity" | "-Infinity";
} & { [key: string]: unknown }

EndpointStatusDetails
EndpointStatusResponse: {
    details?:
        | {
            idle_workers: number
            | "NaN"
            | "Infinity"
            | "-Infinity";
            managers?: number | "NaN" | "Infinity" | "-Infinity" | null;
            outstanding_tasks: number | "NaN" | "Infinity" | "-Infinity";
            pending_tasks: number | "NaN" | "Infinity" | "-Infinity";
            total_workers: number | "NaN" | "Infinity" | "-Infinity";
        } & { [key: string]: unknown }
        | null;
    status: string;
}

EndpointStatusResponse
Example
```
{
         *       "details": {
         *         "idle_workers": 0,
         *         "managers": 1,
         *         "outstanding_tasks": 0,
         *         "pending_tasks": 0,
         *         "total_workers": 1
         *       },
         *       "status": "online"
         *     }
```
- Optionaldetails?:
      | {
          idle_workers: number
          | "NaN"
          | "Infinity"
          | "-Infinity";
          managers?: number | "NaN" | "Infinity" | "-Infinity" | null;
          outstanding_tasks: number | "NaN" | "Infinity" | "-Infinity";
          pending_tasks: number | "NaN" | "Infinity" | "-Infinity";
          total_workers: number | "NaN" | "Infinity" | "-Infinity";
      } & { [key: string]: unknown }
      | null
- status: string
  
  Status
  
  Description
  Endpoint status
ErrorResponse: {
    code: string;
    detail: string;
    error_args: unknown[];
    http_status_code: number;
    reason: string;
    status: string;
}

ErrorResponse
- code: string
  
  Code
- detail: string
  
  Detail
- error_args: unknown[]
  
  Error Args
- http_status_code: number
  
  Http Status Code
- reason: string
  
  Reason
  
  Deprecated
  
  Description
  Deprecated; use detail instead
- status: string
  
  Status
Function: {
    description?: string | null;
    function_code: string;
    function_name?: string | null;
    function_uuid: string;
    metadata: { python_version?: string | null; sdk_version?: string | null };
}

Function
Example
```
{
         *       "description": "My first function",
         *       "function_code": "wuX2RpbGyUjBBfY3JlYXRlX2Z1bmN0 ...",
         *       "function_name": "My Function",
         *       "function_uuid": "11291b86-4f9c-47cb-848e-d3c06285951c",
         *       "metadata": {
         *         "python_version": "3.11.3",
         *         "sdk_version": "2.3.3"
         *       }
         *     }
```
- Optionaldescription?: string | null
  
  Description
  
  Description
  Function description
- function_code: string
  
  Function Code
  
  Description
  Serialized function source code
- Optionalfunction_name?: string | null
  
  Function Name
  
  Description
  Function name
- function_uuid: string
  
  Function Uuid Format: uuid
  
  Description
  Function UUID
- metadata: { python_version?: string | null; sdk_version?: string | null }
  
  Description
  Function metadata
  - Optionalpython_version?: string | null
    
    Python Version
    
    Description
    Python version used to serialize function.
  - Optionalsdk_version?: string | null
    
    Sdk Version
    
    Description
    SDK version used to serialize function.
FunctionMetadata: { python_version?: string | null; sdk_version?: string | null }

FunctionMetadata
- Optionalpython_version?: string | null
  
  Python Version
  
  Description
  Python version used to serialize function.
- Optionalsdk_version?: string | null
  
  Sdk Version
  
  Description
  SDK version used to serialize function.
HTTPValidationError: {
    detail?: {
        ctx?: Record<string, unknown>;
        input?: unknown;
        loc: (string | number)[];
        msg: string;
        type: string;
    }[];
}

HTTPValidationError
- Optionaldetail?: {
      ctx?: Record<string, unknown>;
      input?: unknown;
      loc: (string | number)[];
      msg: string;
      type: string;
  }[]
  
  Detail
MultiUserEndpointConfig: {
    command_queue_info: {
        connection_url: string;
        exchange: string;
        queue: string;
    };
    endpoint_id: string;
    warnings?: string[]
    | null;
}

MultiUserEndpointConfig
- command_queue_info: { connection_url: string; exchange: string; queue: string }
  - connection_url: string
    
    Connection Url
    
    Description
    Connection URL
  - exchange: string
    
    Exchange
    
    Description
    Exchange
  - queue: string
    
    Queue
    
    Description
    Queue
- endpoint_id: string
  
  Endpoint Id Format: uuid
  
  Description
  Endpoint UUID
- Optionalwarnings?: string[] | null
  
  Warnings
  
  Description
  Warnings
MultiUserEndpointRegisterResponse: {
    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[]
    | null;
}

MultiUserEndpointRegisterResponse
Example
```
{
         *       "command_queue_info": {
         *         "connection_url": "amqps://user:password@mq.fqdn",
         *         "exchange": "some_exchange",
         *         "queue": "some_queue"
         *       },
         *       "endpoint_id": "7348422a-1074-427b-a08a-0771068afccc",
         *       "heartbeat_queue_info": {
         *         "connection_url": "amqps://user:password@mq.fqdn",
         *         "exchange": "some_exchange",
         *         "queue": "some_queue",
         *         "queue_publish_kwargs": {
         *           "exchange": "some_exchange",
         *           "mandatory": true,
         *           "properties": {
         *             "delivery_mode": 2
         *           },
         *           "routing_key": "some_key"
         *         }
         *       },
         *       "result_queue_info": {
         *         "connection_url": "amqps://user:password@mq.fqdn",
         *         "exchange": "some_exchange",
         *         "queue": "some_queue",
         *         "queue_publish_kwargs": {
         *           "exchange": "some_exchange",
         *           "mandatory": true,
         *           "properties": {
         *             "delivery_mode": 2
         *           },
         *           "routing_key": "some_key"
         *         }
         *       }
         *     }
```
- command_queue_info: { connection_url: string; exchange: string; queue: string }
  - connection_url: string
    
    Connection Url
    
    Description
    Connection URL
  - exchange: string
    
    Exchange
    
    Description
    Exchange
  - queue: string
    
    Queue
    
    Description
    Queue
- endpoint_id: string
  
  Endpoint Id Format: uuid
  
  Description
  Endpoint UUID
- heartbeat_queue_info: {
      connection_url: string;
      exchange: string;
      queue: string;
      queue_publish_kwargs: {
          exchange: string;
          mandatory: boolean;
          properties: { delivery_mode: number };
          routing_key: string;
      };
  }
  - connection_url: string
    
    Connection Url
    
    Description
    Connection URL
  - exchange: string
    
    Exchange
    
    Description
    Exchange
  - queue: string
    
    Queue
    
    Description
    Queue
  - queue_publish_kwargs: {
        exchange: string;
        mandatory: boolean;
        properties: { delivery_mode: number };
        routing_key: string;
    }
    - exchange: string
      
      Exchange
      
      Description
      Exchange
    - mandatory: boolean
      
      Mandatory
      
      Description
      Mandatory
    - properties: { delivery_mode: number }
      - delivery_mode: number
        
        Delivery Mode
        
        Description
        Delivery mode
    - routing_key: string
      
      Routing Key
      
      Description
      Routing key
- result_queue_info: {
      connection_url: string;
      exchange: string;
      queue: string;
      queue_publish_kwargs: {
          exchange: string;
          mandatory: boolean;
          properties: { delivery_mode: number };
          routing_key: string;
      };
  }
  - connection_url: string
    
    Connection Url
    
    Description
    Connection URL
  - exchange: string
    
    Exchange
    
    Description
    Exchange
  - queue: string
    
    Queue
    
    Description
    Queue
  - queue_publish_kwargs: {
        exchange: string;
        mandatory: boolean;
        properties: { delivery_mode: number };
        routing_key: string;
    }
    - exchange: string
      
      Exchange
      
      Description
      Exchange
    - mandatory: boolean
      
      Mandatory
      
      Description
      Mandatory
    - properties: { delivery_mode: number }
      - delivery_mode: number
        
        Delivery Mode
        
        Description
        Delivery mode
    - routing_key: string
      
      Routing Key
      
      Description
      Routing key
- Optionalwarnings?: string[] | null
  
  Warnings
  
  Description
  Warnings
PlatformInfo: {
    architecture?: [string, string] | null;
    machine?: string | null;
    node?: string | null;
    platform?: string | null;
    processor?: string | null;
    release?: string | null;
}

PlatformInfo
- Optionalarchitecture?: [string, string] | null
  
  Architecture
  
  Description
  Submit host architecture tuple (e.g., ["64bit", "ELF"])
- Optionalmachine?: string | null
  
  Machine
  
  Description
  Submit host machine type (e.g., x86_64)
- Optionalnode?: string | null
  
  Node
  
  Description
  Submit host node name (e.g., login03)
- Optionalplatform?: string | null
  
  Platform
  
  Description
  Submit host platform (e.g., Linux-6.14.0-29-generic-x86_64-with-glibc2.39)
- Optionalprocessor?: string | null
  
  Processor
  
  Description
  Submit host processor name (e.g., x86_64)
- Optionalrelease?: string | null
  
  Release
  
  Description
  Submit host os release (e.g., 6.16.5-2-generic)
PythonInfo: {
    compiler?: string | null;
    implementation?: string | null;
    version?: string | null;
    version_description?: string | null;
    version_info?: [number, number, number, string, number] | null;
    version_tuple?: [number, number, number] | null;
}

PythonInfo
- Optionalcompiler?: string | null
  
  Compiler
  
  Description
  String identifying the compiler used for compiling Python
- Optionalimplementation?: string | null
  
  Implementation
  
  Description
  Python implementation (e.g., CPython)
- Optionalversion?: string | null
  
  Version
  
  Description
  Python version as a dotted triple (e.g., 3.13.7)
- Optionalversion_description?: string | null
  
  Version Description
  
  Description
  Python version string from sys.version (e.g., 3.13.7 (main, Aug 21 2025, 13:50:03) [GCC 13.3.0])
- Optionalversion_info?: [number, number, number, string, number] | null
  
  Version Info
  
  Description
  Python version info from list(sys.version_info) (e.g., [3, 13, 7, 'final', 0])
- Optionalversion_tuple?: [number, number, number] | null
  
  Version Tuple
  
  Description
  Python version as a tuple (major, minor, micro)
ReadQueueInfo: { connection_url: string; exchange: string; queue: string }

ReadQueueInfo
- connection_url: string
  
  Connection Url
  
  Description
  Connection URL
- exchange: string
  
  Exchange
  
  Description
  Exchange
- queue: string
  
  Queue
  
  Description
  Queue
ResourceSpecification: {
    launcher_options?: string | null;
    num_nodes: number;
    num_ranks?: number | null;
    ranks_per_node?: number | null;
}

ResourceSpecification
- Optionallauncher_options?: string | null
  
  Launcher Options
  
  Description
  Options passed through to the MPI launcher command line prefix.
- num_nodes: number
  
  Num Nodes
  
  Description
  Number of nodes required for an MPI application
- Optionalnum_ranks?: number | null
  
  Num Ranks
  
  Description
  Total number of MPI ranks to launch across all nodes.
- Optionalranks_per_node?: number | null
  
  Ranks Per Node
  
  Description
  Number of MPI ranks to launch per node.
ResultAmqpUrlResponse: { connection_url: string; queue_prefix: string }

ResultAmqpUrlResponse
Example
```
{
         *       "connection_url": "amqps://user:password@amq.fqdn",
         *       "queue_prefix": "some_prefix"
         *     }
```
- connection_url: string
  
  Connection Url Format: uri
  
  Description
  Connection URL
- queue_prefix: string
  
  Queue Prefix
  
  Description
  Queue prefix
SubscriptionAdminVerified: { subscription_admin_verified: boolean }

SubscriptionAdminVerified
Example
```
{
         *       "subscription_admin_verified": true
         *     }
```
- subscription_admin_verified: boolean
  
  Subscription Admin Verified
  
  Description
  Indicates that the endpoint has been verified as a valid organizational resource by a Globus subscription administrator.

TaskGroupResponse: {
    create_websockets_queue?: boolean | null;
    taskgroup_id: string;
    tasks: { created_at: string; id: string }[];
}

TaskGroupResponse

Example

{
         *       "create_websockets_queue": true,
         *       "taskgroup_id": "4defbef8-0a1a-4c7b-9c83-b59174fca395",
         *       "tasks": [
         *         {
         *           "created_at": "2021-05-05T15:00:00.000000",
         *           "id": "9e38ed49-7d05-45c4-9ad0-bfa3bc92d6a1"
         *         }
         *       ]
         *     }

Optionalcreate_websockets_queue?: boolean | null

Create Websockets Queue

Description
Create websockets queue
taskgroup_id: string

Taskgroup Id Format: uuid

Description
Task Group UUID
tasks: { created_at: string; id: string }[]

Tasks

TaskGroupResponseTask: { created_at: string; id: string }

TaskGroupResponseTask
- created_at: string
  
  Created At Format: date-time
  
  Description
  Task creation time
- id: string
  
  Id Format: uuid
  
  Description
  Task UUID

TaskStatusResponse: {
    completion_t?: string | null;
    details?: { [key: string]: unknown } | null;
    exception?: string | null;
    result?: string | null;
    status: unknown;
    task_id: string;
}

TaskStatusResponse

Example

{
         *       "completion_t": "1677183605.212898",
         *       "details": {
         *         "dill_version": "0.3.5.1",
         *         "globus_compute_sdk_version": "2.3.2",
         *         "os": "Linux-5.19.0-1025-aws-x86_64-with-glibc2.35",
         *         "python_version": "3.10.4",
         *         "task_transitions": {
         *           "execution-end": 1692742846.123456,
         *           "execution-start": 1692742841.843334
         *         }
         *       },
         *       "result": "10000",
         *       "status": "success",
         *       "task_id": "7dac44aa-c480-4460-b453-a47b03b031f4"
         *     }

Optionalcompletion_t?: string | null

Completion T

Description
Task completion Unix time
Optionaldetails?: { [key: string]: unknown } | null

Details

Description
Task execution details
Optionalexception?: string | null

Exception

Description
Exception
Optionalresult?: string | null

Result

Description
Task result
status: unknown

Status

Description
Task status
task_id: string

Task Id Format: uuid

Description
Task UUID

UserRuntime: {
    globus_compute_sdk_version?: string | null;
    globus_sdk_version?: string | null;
    platform?:
        | {
            architecture?: [string, string]
            | null;
            machine?: string | null;
            node?: string | null;
            platform?: string | null;
            processor?: string | null;
            release?: string | null;
        }
        | null;
    python?: | {
        compiler?: string
        | null;
        implementation?: string | null;
        version?: string | null;
        version_description?: string | null;
        version_info?: [number, number, number, string, number] | null;
        version_tuple?: [number, number, number] | null;
    }
    | null;
    python_version?: string
    | null;
}

UserRuntime
- Optionalglobus_compute_sdk_version?: string | null
  
  Globus Compute Sdk Version
  
  Description
  Globus Compute SDK version (e.g., 4.1.0)
- Optionalglobus_sdk_version?: string | null
  
  Globus Sdk Version
  
  Description
  Globus SDK version (e.g., 3.63.0)
- Optionalplatform?:
      | {
          architecture?: [string, string]
          | null;
          machine?: string | null;
          node?: string | null;
          platform?: string | null;
          processor?: string | null;
          release?: string | null;
      }
      | null
  
  Description
  General platform information from the user's installation
- Optionalpython?:
      | {
          compiler?: string
          | null;
          implementation?: string | null;
          version?: string | null;
          version_description?: string | null;
          version_info?: [number, number, number, string, number] | null;
          version_tuple?: [number, number, number] | null;
      }
      | null
  
  Description
  Information about the submitting user's Python runtime
- Optionalpython_version?: string | null
  
  Python Version
  
  Deprecated
  
  Description
  [use python instead] Python version string from sys.version
ValidationError: {
    ctx?: Record<string, unknown>;
    input?: unknown;
    loc: (string | number)[];
    msg: string;
    type: string;
}

ValidationError
- Optionalctx?: Record<string, unknown>
  
  Context
- Optionalinput?: unknown
  
  Input
- loc: (string | number)[]
  
  Location
- msg: string
  
  Message
- type: string
  
  Error Type
ValidationErrorResponse: {
    code: string;
    detail: {
        ctx?: Record<string, unknown>;
        input?: unknown;
        loc: (string | number)[];
        msg: string;
        type: string;
    }[];
    error_args: unknown[];
    http_status_code: number;
    reason: {
        ctx?: Record<string, unknown>;
        input?: unknown;
        loc: (string | number)[];
        msg: string;
        type: string;
    }[];
    status: string;
}

ValidationErrorResponse
- code: string
  
  Code
- detail: {
      ctx?: Record<string, unknown>;
      input?: unknown;
      loc: (string | number)[];
      msg: string;
      type: string;
  }[]
  
  Detail
- error_args: unknown[]
  
  Error Args
- http_status_code: number
  
  Http Status Code
- reason: {
      ctx?: Record<string, unknown>;
      input?: unknown;
      loc: (string | number)[];
      msg: string;
      type: string;
  }[]
  
  Reason
  
  Deprecated
  
  Description
  Deprecated; use detail instead
- status: string
  
  Status
VersionService: "all" | "api"

VersionService
WriteQueueInfo: {
    connection_url: string;
    exchange: string;
    queue: string;
    queue_publish_kwargs: {
        exchange: string;
        mandatory: boolean;
        properties: { delivery_mode: number };
        routing_key: string;
    };
}

WriteQueueInfo
- connection_url: string
  
  Connection Url
  
  Description
  Connection URL
- exchange: string
  
  Exchange
  
  Description
  Exchange
- queue: string
  
  Queue
  
  Description
  Queue
- queue_publish_kwargs: {
      exchange: string;
      mandatory: boolean;
      properties: { delivery_mode: number };
      routing_key: string;
  }
  - exchange: string
    
    Exchange
    
    Description
    Exchange
  - mandatory: boolean
    
    Mandatory
    
    Description
    Mandatory
  - properties: { delivery_mode: number }
    - delivery_mode: number
      
      Delivery Mode
      
      Description
      Delivery mode
  - routing_key: string
    
    Routing Key
    
    Description
    Routing key
WriteQueuePublishKwargs: {
    exchange: string;
    mandatory: boolean;
    properties: { delivery_mode: number };
    routing_key: string;
}

WriteQueuePublishKwargs
- exchange: string
  
  Exchange
  
  Description
  Exchange
- mandatory: boolean
  
  Mandatory
  
  Description
  Mandatory
- properties: { delivery_mode: number }
  - delivery_mode: number
    
    Delivery Mode
    
    Description
    Delivery mode
- routing_key: string
  
  Routing Key
  
  Description
  Routing key
WriteQueuePublishProperties: { delivery_mode: number }

WriteQueuePublishProperties
- delivery_mode: number
  
  Delivery Mode
  
  Description
  Delivery mode

Interface components

Index

Properties

Properties

headers

parameters

pathItems

requestBodies

responses

schemas

Type Declaration

AllowedFunctionsResponse: { endpoint_id: string; functions?: string[] | null; restricted: boolean }

Example

endpoint_id: string

Description

Optionalfunctions?: string[] | null

Description

restricted: boolean

Description

BatchStatusRequest: { task_ids: string[] }

Example

task_ids: string[]

Description

BatchStatusResponse: { response: string; results: { [key: string]: { completion_t?: string | null; exception?: string | null; reason?: string | null; result?: string | null; status: unknown; task_id: string; }; };}

Example

response: string

Description

results: { [key: string]: { completion_t?: string | null; exception?: string | null; reason?: string | null; result?: string | null; status: unknown; task_id: string; };}

Description

BatchStatusResponseResults: { completion_t?: string | null; exception?: string | null; reason?: string | null; result?: string | null; status: unknown; task_id: string;}

Optionalcompletion_t?: string | null

Description

Optionalexception?: string | null

Description

Optionalreason?: string | null

Description

Optionalresult?: string | null

Description

status: unknown

Description

task_id: string

Description

BatchSubmitResponseTask: { http_status_code: number; reason?: string | null; status: string; task_uuid: string;}

http_status_code: number

Description

Optionalreason?: string | null

Description

status: string

Description

task_uuid: string

Description

BuildStatus: | "failed" | "provided" | "submitted" | "initialized" | "queued" | "building" | "ready"

compute_web_service__schemas__v2__endpoint__EndpointLockResponse: { endpoint_id: string; lock_expiration_timestamp: string }

Example

endpoint_id: string

Description

lock_expiration_timestamp: string

Description

Example

Optionalallowed_functions?: string[] | null

Description

Optionalauthentication_policy?: string | null

Description

Optionaldisplay_name?: string | null

Description

endpoint_name: string

Description

endpoint_uuid: string

Description

multi_user: boolean

Description

Default

Optionalversion?: string | null

Description

compute_web_service__schemas__v2__function__RegisterFunctionMetadata: { python_version?: string | null; sdk_version?: string | null }

Optionalpython_version?: string | null

Description

Optionalsdk_version?: string | null

Description

Example

`Optional`functions?: string[] | null

BatchStatusResponse: {
response: string;
results: {
[key: string]: {
completion_t?: string | null;
exception?: string | null;
reason?: string | null;
result?: string | null;
status: unknown;
task_id: string;
};
};
}

results: {
[key: string]: {
completion_t?: string | null;
exception?: string | null;
reason?: string | null;
result?: string | null;
status: unknown;
task_id: string;
};
}

BatchStatusResponseResults: {
completion_t?: string | null;
exception?: string | null;
reason?: string | null;
result?: string | null;
status: unknown;
task_id: string;
}

`Optional`completion_t?: string | null

`Optional`exception?: string | null

`Optional`reason?: string | null

`Optional`result?: string | null

BatchSubmitResponseTask: {
http_status_code: number;
reason?: string | null;
status: string;
task_uuid: string;
}

`Optional`reason?: string | null

BuildStatus:
| "failed"
| "provided"
| "submitted"
| "initialized"
| "queued"
| "building"
| "ready"

compute_web_serviceschemasv2endpointEndpointLockResponse: { endpoint_id: string; lock_expiration_timestamp: string }

`Optional`allowed_functions?: string[] | null

`Optional`authentication_policy?: string | null

`Optional`display_name?: string | null

`Optional`version?: string | null

compute_web_serviceschemasv2functionRegisterFunctionMetadata: { python_version?: string | null; sdk_version?: string | null }

`Optional`python_version?: string | null

`Optional`sdk_version?: string | null

`Optional`container_uuid?: string | null

`Optional`description?: string | null

`Optional`entry_point?: string | null

`Optional`group?: string | null

`Optional`metadata?: { python_version?: string | null; sdk_version?: string | null } | null

compute_web_serviceschemasv2functionRegisterFunctionResponse: { function_uuid: string }

compute_web_serviceschemasv2taskBatchSubmitRequest: {
create_websocket_queue: boolean;
task_group_id?: string | null;
tasks: [string, string, string][];
}

`Optional`task_group_id?: string | null

compute_web_serviceschemasv2taskBatchSubmitResponse: {
response: string;
results: (
| string
| {
http_status_code: number;
reason?: string
| null;
status: string;
task_uuid: string;
}
)[];
task_group_id?: string
| null;
}

results: (
| string
| {
http_status_code: number;
reason?: string
| null;
status: string;
task_uuid: string;
}
)[]

`Optional`task_group_id?: string | null

compute_web_serviceschemasv3endpointsEndpointLockResponse: { endpoint_id: string; lock_expiration_timestamp: number }

`Optional`admins?: string[] | null

`Optional`allowed_functions?: string[] | null

`Optional`authentication_policy?: string | null

`Optional`display_name?: string | null

`Optional`config?: { [key: string]: unknown } | null

`Optional`description?: string | null

`Optional`endpoint_config?: string | null