On this page

    API Reference

    note:

    Configuring S3 and Glue Catalog sources via REST is not currently supported.

    For information on the relationship of the Dremio Cloud entities, see the object model topic.

    API Endpoint

    To use Dremio Cloud APIs, use the endpoint for your control plane.

    US Control Plane
    https://api.dremio.cloud/v0/
    
    EU Control Plane
    https://api.eu.dremio.cloud/v0/
    

    Authentication

    Dremio supports authentication of your REST API calls through personal access tokens (PATs). You can obtain a personal access token by following the steps the topic Personal Access Tokens.

    Example Request for PAT in the Authorization Header
    curl -X GET 'https://api.dremio.cloud/v0/clouds/' \
    -H 'Authorization: Bearer ncddMzDURMSnACVC+UDt7jGpQCNkYEEKpUi30CdY44CxAigBxfHbhtNw/tiZWw==' \
    -H 'Content-Type: application/json' \
    

    Idempotent Requests

    Idempotence is an operation or a service call that produces the same result when it is called multiple times.

    API endpoints support idempotency to safely retry user requests without performing a duplicate operation. This is helpful when an API request is interrupted in transit and a response is not received. In such cases, you can retry that request with the same idempotency key to ensure that there is no duplicate request.

    To create an idempotent request, add a requestId parameter to the request. The value is a unique generated UUID. The server uses the idempotency key to identify consequent retries of the same API request.

    Only POST operations accept the idempotency key.

    warning:

    To get a successful POST response for entities, you must add the requestId parameter in the corresponding POST request.

    Adding idempotent keys in PUT, GET, and DELETE operations creates no impact as they are idempotent.

    An idempotent key can be reused after 24 hours in a new POST operation.