Skip to content
digizeDocs

Get a D1 database

GET
/api/v1/storage/d1/{database}
curl --request GET \
  --url https://digize.com/api/v1/storage/d1/example \
  --header 'x-api-key: <x-api-key>'

One D1 database: its tables with their columns and first rows, 30 days of metrics, and the points Time Travel can restore to. Null if there’s no such database.

Needs the sites:read permission.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
database
required
string
>= 1 characters <= 100 characters

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
Any of:
object
id
required
string
name
required
string
cloudflareName
required
string
createdAt
required
string format: date-time
location
required
string
sizeBytes
required
number
tables
required
number
rowsRead
required
number
rowsWritten
required
number
readReplication
required
boolean
boundTo
required
Array<object>
object
worker
required
string
variable
required
string | null
live
required
boolean
tableList
required
Array<object>
object
name
required
string
rows
required
number
columns
required
Array<object>
object
name
required
string
type
required
string
primaryKey
boolean
notNull
boolean
sample
required
Array<Array<string | number | null>>
days
required
Array<object>
object
date
required
string format: date-time
rowsRead
required
number
rowsWritten
required
number
p50
required
number
p90
required
number
restorePoints
required
Array<object>
object
id
required
string
bookmark
required
string | null
at
required
string format: date-time
label
required
string

Example generated

{
  "id": "example",
  "name": "example",
  "cloudflareName": "example",
  "createdAt": "2026-04-15T12:00:00Z",
  "location": "example",
  "sizeBytes": 1,
  "tables": 1,
  "rowsRead": 1,
  "rowsWritten": 1,
  "readReplication": true,
  "boundTo": [
    {
      "worker": "example",
      "variable": "example"
    }
  ],
  "live": true,
  "tableList": [
    {
      "name": "example",
      "rows": 1,
      "columns": [
        {
          "name": "example",
          "type": "example",
          "primaryKey": true,
          "notNull": true
        }
      ],
      "sample": [
        [
          "example"
        ]
      ]
    }
  ],
  "days": [
    {
      "date": "2026-04-15T12:00:00Z",
      "rowsRead": 1,
      "rowsWritten": 1,
      "p50": 1,
      "p90": 1
    }
  ],
  "restorePoints": [
    {
      "id": "example",
      "bookmark": "example",
      "at": "2026-04-15T12:00:00Z",
      "label": "example"
    }
  ]
}

400

Section titled “400”

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

401

Section titled “401”

No key, or one that’s unknown, off or expired.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

403

Section titled “403”

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

404

Section titled “404”

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

429

Section titled “429”

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}