Skip to main content

Projects

A project is the logical entity for isolating compute, data and other resources needed by a team for data analysis. An organization may contain multiple projects. Projects are linked to your cloud account - your first project was created and linked to your cloud account as part of the signup. This API allows you to add, modify, delete and list projects.

Project Object
{
    "name": "default-project",
    "id": "c683b988-aa93-439c-a9ac-0d7f72b53d23",
    "cloudId": "37b34779-13f1-48e5-b2c8-f3db4c824733",
    "state": "ACTIVE",
    "createdBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
    "modifiedBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
    "createdAt": "Thu Aug 19 14:39:38 UTC 2021",
    "modifiedAt": "Thu Aug 19 14:39:46 UTC 2021",
    "projectStore": "my.dremio.store",
    "credentials": {
      "type": "ACCESS_KEY",
      "accessKeyId": "AKIAJIPU77TQL8LR6OIR",
      "secretAccessKey": null
    }
  }

Project Attributes​

{{< api-section file="data/api/projects.json" data="projectAttributes" >}}

credentials​

{{< api-section file="data/api/projects.json" data="credentials" >}}

Listing All Projects​

Returns a list of all the projects and the metadata for each project.

Listing All Projects
GET /v0/projects
Example Request
curl -X GET 'https://api.dremio.cloud/v0/projects' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'
Example Response
[
  {
    "name": "Default Project",
    "id": "c683b988-aa93-439c-a9ac-0d7f72b53d23",
    "cloudId": "37b34779-13f1-48e5-b2c8-f3db4c824733",
    "state": "ACTIVE",
    "createdBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
    "modifiedBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
    "createdAt": "Thu Aug 19 14:39:38 UTC 2021",
    "modifiedAt": "Thu Aug 19 14:39:46 UTC 2021",
    "projectStore": "my.dremio.store",
    "credentials": {
      "type": "ACCESS_KEY",
      "accessKeyId": "AKIAJIPU77TQL8LR6OIR",
      "secretAccessKey": null
    }
  }
]

Responses​

{{< api-responses file="data/api/projects.json" data="listingAllProjectsResponses" >}}

Adding a Project​

Add a project.

Adding a Project
POST /v0/projects

Parameters​

Project​

{{< api-section file="data/api/projects.json" data="addingProjectParameters" >}}

credentials​

{{< api-section file="data/api/projects.json" data="addingCredentialsParameters" >}}


Example Request
curl -X POST 'https://api.dremio.cloud/v0/projects' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json' \
-D '{
      "name": "docproject",
      "cloudId": "37b34779-13f1-48e5-b2c8-f3db4c824733",
      "projectStore": "my.dremio.store",
      "credentials": {
        "type": "ACCESS_KEY",
        "accessKeyId": "AKIAJIPU77TQL8LR6OIR",
        "secretAccessKey": "vJalrXUtnFEMI/K7MDENG/bPxRfiDYEXAMPLEKEY"
      },
      "requestId": "a7801e74-6c34-48b4-9e42-2cacdf06d31c"
    }'
Example Response
{
    "name": "docproject",
    "id": "c683b988-aa93-439c-a9ac-0d7f72b53d23",
    "cloudId": "37b34779-13f1-48e5-b2c8-f3db4c824733",
    "state": "ACTIVE",
    "createdBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
    "modifiedBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
    "createdAt": "Thu Aug 19 14:39:38 UTC 2021",
    "modifiedAt": "Thu Aug 19 14:39:46 UTC 2021",
    "projectStore": "my.dremio.store",
    "credentials": {
      "type": "ACCESS_KEY",
      "accessKeyId": "AKIAJIPU77TQL8LR6OIR",
      "secretAccessKey": "vJalrXUtnFEMI/K7MDENG/bPxRfiDYEXAMPLEKEY"
    }
  }

Responses​

{{< api-responses file="data/api/projects.json" data="addingProjectResponses" >}}

Retrieving a Project​

Get the project metadata for an existing project by providing the project ID that was returned on creation of the project.

Retrieiving a Project
GET /v0/projects/{id}

Parameters​

{{< api-section file="data/api/projects.json" data="retrievingProjectParameters" >}}

Example Request
curl -X GET 'https://api.dremio.cloud/v0/projects/05e2d620-5978-4269-8c96-aa463df830b7' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'
Example Response
{
  "name": "docproject",
  "id": "05e2d620-5978-4269-8c96-aa463df830b7",
  "cloudId": "37b34779-13f1-48e5-b2c8-f3db4c824733",
  "state": "ACTIVE",
  "createdBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
  "modifiedBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
  "createdAt": "Sat Aug 21 12:22:51 UTC 2021",
  "modifiedAt": "Sat Aug 21 12:22:59 UTC 2021",
  "projectStore": "my.dremio.store",
  "credentials": {
    "type": "ACCESS_KEY",
    "accessKeyId": "AKIAJIPU77TQL8LR6OIR",
    "secretAccessKey": null
  } 
}

Responses​

{{< api-responses file="data/api/projects.json" data="retrievingProjectResponses" >}}

Modifying a Project​

Modify the project by providing the project ID that was returned on creation of the project. Parameters that are not provided will be left unchanged.

note:

Currently only the name of a project can be modified.

Modifying a Project
PUT /v0/projects/{id}

Parameters​

{{< api-section file="data/api/projects.json" data="modifyingProjectParameters" >}}

Example Request
curl -X PUT 'https://api.dremio.cloud/v0/projects/05e2d620-5978-4269-8c96-aa463df830b7' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json' \
-D '{
    "name": "doc-project" 
 }'
Example Response
{
    "name": "doc-project",
    "id": "c683b988-aa93-439c-a9ac-0d7f72b53d23",
    "cloudId": "37b34779-13f1-48e5-b2c8-f3db4c824733",
    "state": "ACTIVE",
    "createdBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
    "modifiedBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
    "createdAt": "Thu Aug 19 14:39:38 UTC 2021",
    "modifiedAt": "Fri Aug 20 12:01:57 UTC 2021",
    "projectStore": "my.dremio.store",
    "credentials": {
      "type": "ACCESS_KEY",
      "accessKeyId": "AKIAJIPU77TQL8LR6OIR",
      "secretAccessKey": "vJalrXUtnFEMI/K7MDENG/bPxRfiDYEXAMPLEKEY"
    }
  }

Responses​

{{< api-responses file="data/api/projects.json" data="modifyingProjectResponses" >}}

Deleting a Project​

Delete the project by providing the project ID that was returned on creation of the project.

note:

Dremio Cloud does not allow you to delete a project that is the only project in an organization.

Deleting a Project
DELETE /v0/projects/{id}

Parameters​

{{< api-section file="data/api/projects.json" data="deletingProjectParameters" >}}

Example Request
curl -X DELETE 'https://api.dremio.cloud/v0/projects/05e2d620-5978-4269-8c96-aa463df830b7' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'
Example Response
No response

Responses​

{{< api-responses file="data/api/projects.json" data="deletingProjectResponses" >}}