---
title: "Get system storage REST API | HitKeep"
description: "Reference for the HitKeep REST API operation Get system storage, including request parameters, responses, and authentication notes."
canonical: "https://hitkeep.com/api/operations/apiadminsystemstorage/"
---

# Get system storage REST API

GET

/api/admin/system/storage

FetchcURL

```
const url = 'http://127.0.0.1:25737/api/admin/system/storage';
const options = {method: 'GET', headers: {cookie: 'hk_token=<hk_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```
curl --request GET \
  --url http://127.0.0.1:25737/api/admin/system/storage \
  --cookie hk_token=<hk_token>
```

-

Returns configured data paths, shared and tenant database sizes, backup path, spam cache path, disk capacity fields when available, and the shared database’s DuckDB memory breakdown.

## Authorizations

- **[cookieAuth](https://hitkeep.com/api/#cookieauth)**

## Responses

### 200

System storage

application/json

object

**backup_path**

string

**control_db_bytes**

integer format: int64

**control_db_path**

string

**data_path**

string

**disk_available_bytes**

integer format: int64

**disk_total_bytes**

integer format: int64

**duckdb_memory**

Array<object>

object

**memory_bytes**

integer format: int64

**tag**

string

**temporary_storage_bytes**

integer format: int64

**shared_db_bytes**

integer format: int64

**shared_db_path**

string

**spam_cache_path**

string

**tenant_db_count**

integer

**tenant_duckdb_memory**

Array<object>

object

**memory_bytes**

integer format: int64

**tag**

string

**temporary_storage_bytes**

integer format: int64

**tenant_dbs**

Array<object>

object

**bytes**

integer format: int64

**is_default**

boolean

**name**

string

**path**

string

**tenant_id**

string format: uuid

##### Examplegenerated

```
{
  "backup_path": "example",
  "control_db_bytes": 1,
  "control_db_path": "example",
  "data_path": "example",
  "disk_available_bytes": 1,
  "disk_total_bytes": 1,
  "duckdb_memory": [
    {
      "memory_bytes": 1,
      "tag": "example",
      "temporary_storage_bytes": 1
    }
  ],
  "shared_db_bytes": 1,
  "shared_db_path": "example",
  "spam_cache_path": "example",
  "tenant_db_count": 1,
  "tenant_duckdb_memory": [
    {
      "memory_bytes": 1,
      "tag": "example",
      "temporary_storage_bytes": 1
    }
  ],
  "tenant_dbs": [
    {
      "bytes": 1,
      "is_default": true,
      "name": "example",
      "path": "example",
      "tenant_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    }
  ]
}
```

[Previous Refresh spam database](https://hitkeep.com/api/operations/apiadminsystemspam-filterrefresh/)[Next List all teams](https://hitkeep.com/api/operations/apiadminteams/)