List D1 Databases

client.D1.Database.List(ctx, params) (*V4PagePaginationArray[DatabaseListResponse], error)

GET/accounts/{account_id}/d1/database

Returns a list of D1 databases.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

D1 ReadD1 Write

ParametersExpand Collapse

params DatabaseListParams

AccountID param.Field[string]

Path param: Account identifier tag.

maxLength32

Name param.Field[string]optional

Query param: a database name to search for.

Page param.Field[float64]optional

Query param: Page number of paginated results.

minimum1

PerPage param.Field[float64]optional

Query param: Number of items per page.

maximum10000

minimum10

ReturnsExpand Collapse

type DatabaseListResponse struct{…}

CreatedAt Timeoptional

Specifies the timestamp the resource was created as an ISO8601 string.

formatdate-time

Jurisdiction DatabaseListResponseJurisdictionoptional

Specify the location to restrict the D1 database to run and store data. If this option is present, the location hint is ignored.

One of the following:

const DatabaseListResponseJurisdictionEu DatabaseListResponseJurisdiction = "eu"

const DatabaseListResponseJurisdictionFedramp DatabaseListResponseJurisdiction = "fedramp"

Name stringoptional

D1 database name.

UUID stringoptional

D1 database identifier (UUID).

Version stringoptional

List D1 Databases

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/d1"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.D1.Database.List(context.TODO(), d1.DatabaseListParams{
    AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "created_at": "2022-11-15T18:25:44.442097Z",
      "jurisdiction": "eu",
      "name": "my-database",
      "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "version": "production"
    }
  ],
  "success": true,
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "created_at": "2022-11-15T18:25:44.442097Z",
      "jurisdiction": "eu",
      "name": "my-database",
      "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "version": "production"
    }
  ],
  "success": true,
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}