Hide navigation sidebar

Hide table of contents sidebar

Toggle site navigation sidebar

MXCuBE-Web 4.608.0 documentation

Toggle table of contents sidebar

MXCuBE-Web 4.608.0 documentation

MXCuBE-Web
Configuration
Toggle navigation of Configuration
- server.yaml
- ui.yaml
Developer documentation
Toggle navigation of Developer documentation
- API
  Toggle navigation of API
  - mxcubeweb
    Toggle navigation of mxcubeweb
    - mxcubeweb.app
    - mxcubeweb.config
    - mxcubeweb.core
      Toggle navigation of mxcubeweb.core
      - mxcubeweb.core.adapter
        Toggle navigation of mxcubeweb.core.adapter
        
        mxcubeweb.core.adapter.actuator_adapter
        
        mxcubeweb.core.adapter.adapter_base
        
        mxcubeweb.core.adapter.adapter_manager
        
        mxcubeweb.core.adapter.beam_adapter
        
        mxcubeweb.core.adapter.beamline_action_adapter
        
        mxcubeweb.core.adapter.beamline_adapter
        
        mxcubeweb.core.adapter.data_publisher_adapter
        
        mxcubeweb.core.adapter.detector_adapter
        
        mxcubeweb.core.adapter.diffractometer_adapter
        
        mxcubeweb.core.adapter.energy_adapter
        
        mxcubeweb.core.adapter.machine_info_adapter
        
        mxcubeweb.core.adapter.motor_adapter
        
        mxcubeweb.core.adapter.nstate_adapter
        
        mxcubeweb.core.adapter.sample_changer_adapter
        
        mxcubeweb.core.adapter.sample_view_adapter
        
        mxcubeweb.core.adapter.wavelength_adapter
      - mxcubeweb.core.components
        Toggle navigation of mxcubeweb.core.components
        
        mxcubeweb.core.components.chat
        
        mxcubeweb.core.components.component_base
        
        mxcubeweb.core.components.harvester
        
        mxcubeweb.core.components.lims
        
        mxcubeweb.core.components.log
        
        mxcubeweb.core.components.queue
        
        mxcubeweb.core.components.user
        Toggle navigation of mxcubeweb.core.components.user
        
        mxcubeweb.core.components.user.database
        
        mxcubeweb.core.components.user.dummyusermanager
        
        mxcubeweb.core.components.user.usermanager
        
        mxcubeweb.core.components.workflow
      - mxcubeweb.core.models
        Toggle navigation of mxcubeweb.core.models
        
        mxcubeweb.core.models.adaptermodels
        
        mxcubeweb.core.models.configmodels
        
        mxcubeweb.core.models.generic
        
        mxcubeweb.core.models.usermodels
      - mxcubeweb.core.server
        Toggle navigation of mxcubeweb.core.server
        
        mxcubeweb.core.server.csp
        
        mxcubeweb.core.server.limiter
        
        mxcubeweb.core.server.openapidoc
        
        mxcubeweb.core.server.resource_handler
      - mxcubeweb.core.util
        Toggle navigation of mxcubeweb.core.util
        
        mxcubeweb.core.util.convertutils
        
        mxcubeweb.core.util.fsutils
        
        mxcubeweb.core.util.networkutils
    - mxcubeweb.logging_handler
    - mxcubeweb.routes
      Toggle navigation of mxcubeweb.routes
    - mxcubeweb.server
    - mxcubeweb.state_storage
- How to contribute to mxcubeweb
- Installing a development environment
- Working with documentation
- Front-end architecture
- Login
- Sample Changer changes and Sample Changer maintenance
- Development tutorial
- Automated Testing
- Deployment
- YAML configuration migration
- HardwareObject Adapters
REST API
Toggle navigation of REST API

Toggle table of contents sidebar

Remote access REST API#

POST /mxcube/api/v0.1/ra/cancel_request#: Cancel request for control.

Sample view REST API

Copyright © 2025, The MXCuBE collaboration

Made with Sphinx and @pradyunsg's Furo

Last updated on Oct 19, 2023