---
title: "DECTRIS D.LAB REST API"
url: "https://help.dectris.cloud/en/article/dectris-dlab-rest-api"
language: "en"
last_updated: "2026-07-15T07:49:27.121Z"
---

# DECTRIS D.LAB REST API

The REST API is designed for automation of tasks and streamlined instrument integration to DECTRIS D.LAB. The API endpoints are available **exclusively for instruments that are connected to DECTRIS D.LAB**.

### Documentation

REST API documentation can be found at : [API Documentation Page](https://api.dectris.cloud/v0/docs/index.html#/)

### Authentication

Access to the API is protected through **token-based authentication**. Each instrument must include a **valid token** to each API request. 

Tokens are instrument specific and can be **generated, revoked and managed** in the instrument's **Cockpit** by the laboratory staff. This ensures that each instrument's access can be securely controlled and audited. 

We recommend **storing tokens securely** on the instrument’s control system and rotating them periodically according to your facility’s security practices.

### API Resources

#### Experiment Management

Everything about your experiments

-   **Create Experiment**: Initialize a new experiment.
-   **Filter Experiments by Keyword**: Retrieve a list of experiments matching a specific keyword.
-   **Add Collaborators**: Add one or more collaborators to a specific experiment.
-   **Remove Collaborators**: Remove collaborators from a specific experiment.
-   **Get Experiment Details**: Retrieve metadata and configuration of a specific experiment.
-   **Update Experiment Details**: Modify the metadata or settings of an existing experiment.

* * *

#### Laboratory Management

Information about your running experiments

-   **Get Active Experiment**: Retrieve the experiment currently running on the instrument.
-   **Switch Active Experiment**: Change the currently active experiment.
-   **Get System Status**: Check the status of the local HUB and its connection to DECTRIS D.LAB.
-   **Toggle Paused Upload**: Enable or disable paused uploads from the laboratory.

* * *

#### User Management

Find and change the Principal Investigator of your experiment

-   **Get Principal Investigator**: Retrieve the current PI for a specific experiment.
-   **Update Principal Investigator**: Assign or update the PI for an experiment.

* * *

#### Data Upload

Manage file uploads for active experiments

-   **Upload Auxiliary Files**: Upload files to the auxiliary folder of the active experiment.

* * *

### Additional Resources

-   **API Documentation**: For a comprehensive list of endpoints and parameters, refer to the [DECTRIS D.LAB API Documentation](https://api.dectris.cloud/v0/docs/index.html#/)
-   **Support**: If you encounter issues or have questions, contact our support team at support@dectris.cloud.