---
title: Hyperdrive
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api/go)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Hyperdrive
##### ModelsExpand Collapse
type Hyperdrive struct{…}
ID string
Define configurations using a unique string identifier.
maxLength32
Link to this property
Name string
The name of the Hyperdrive configuration. Used to identify the configuration in the Cloudflare dashboard and API.
maxLength2048
Link to this property
Origin HyperdriveOrigin
Combines database connection fields with exactly one supported network location.
One of the following:
HyperdriveOriginPublicDatabase
Database string
Set the name of your origin database.
maxLength2048
Link to this property
Host string
Defines the publicly reachable hostname or IP of your origin database. Private, loopback, and link-local IP addresses are not allowed.
Link to this property
Password string
Set the password needed to access your origin database. The API never returns this write-only value.
maxLength2048
Link to this property
Port int64
Defines the port of your origin database. Defaults to 5432 for PostgreSQL or 3306 for MySQL if not specified.
maximum65535
minimum1
Link to this property
Scheme HyperdriveOriginPublicDatabaseScheme
Specifies the URL scheme used to connect to your origin database.
One of the following:
const HyperdriveOriginPublicDatabaseSchemePostgres HyperdriveOriginPublicDatabaseScheme = "postgres"
Link to this property
const HyperdriveOriginPublicDatabaseSchemePostgresql HyperdriveOriginPublicDatabaseScheme = "postgresql"
Link to this property
const HyperdriveOriginPublicDatabaseSchemeMysql HyperdriveOriginPublicDatabaseScheme = "mysql"
Link to this property
Link to this property
User string
Set the user of your origin database.
maxLength2048
Link to this property
Link to this property
HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnel
AccessClientID string
Defines the Client ID of the Access token to use when connecting to the origin database.
Link to this property
AccessClientSecret string
Defines the Client Secret of the Access Token to use when connecting to the origin database. The API never returns this write-only value.
Link to this property
Database string
Set the name of your origin database.
maxLength2048
Link to this property
Host string
Defines the host (hostname or IP) of your origin database.
Link to this property
Password string
Set the password needed to access your origin database. The API never returns this write-only value.
maxLength2048
Link to this property
Scheme HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnelScheme
Specifies the URL scheme used to connect to your origin database.
One of the following:
const HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnelSchemePostgres HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnelScheme = "postgres"
Link to this property
const HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnelSchemePostgresql HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnelScheme = "postgresql"
Link to this property
const HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnelSchemeMysql HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnelScheme = "mysql"
Link to this property
Link to this property
User string
Set the user of your origin database.
maxLength2048
Link to this property
Link to this property
HyperdriveOriginDatabaseReachableThroughAWorkersVPC
Database string
Set the name of your origin database.
maxLength2048
Link to this property
Password string
Set the password needed to access your origin database. The API never returns this write-only value.
maxLength2048
Link to this property
Scheme HyperdriveOriginDatabaseReachableThroughAWorkersVPCScheme
Specifies the URL scheme used to connect to your origin database.
One of the following:
const HyperdriveOriginDatabaseReachableThroughAWorkersVPCSchemePostgres HyperdriveOriginDatabaseReachableThroughAWorkersVPCScheme = "postgres"
Link to this property
const HyperdriveOriginDatabaseReachableThroughAWorkersVPCSchemePostgresql HyperdriveOriginDatabaseReachableThroughAWorkersVPCScheme = "postgresql"
Link to this property
const HyperdriveOriginDatabaseReachableThroughAWorkersVPCSchemeMysql HyperdriveOriginDatabaseReachableThroughAWorkersVPCScheme = "mysql"
Link to this property
Link to this property
ServiceID string
The identifier of the Workers VPC Service to connect through. Hyperdrive will egress through the specified VPC Service to reach the origin database.
Link to this property
User string
Set the user of your origin database.
maxLength2048
Link to this property
Link to this property
Link to this property
Caching HyperdriveCachingOptional
One of the following:
HyperdriveCachingHyperdriveHyperdriveCachingCommon
Disabled boolOptional
Set to true to disable caching of SQL responses. Default is false.
Link to this property
Link to this property
HyperdriveCachingHyperdriveHyperdriveCachingEnabled
Disabled boolOptional
Set to true to disable caching of SQL responses. Default is false.
Link to this property
MaxAge int64Optional
Specify the maximum duration (in seconds) items should persist in the cache. Defaults to 60 seconds if not specified.
Link to this property
StaleWhileRevalidate int64Optional
Specify the number of seconds the cache may serve a stale response. Defaults to 15 seconds if not specified.
Link to this property
Link to this property
Link to this property
CreatedOn TimeOptional
Defines the creation time of the Hyperdrive configuration.
formatdate-time
Link to this property
ModifiedOn TimeOptional
Defines the last modified time of the Hyperdrive configuration.
formatdate-time
Link to this property
MTLS HyperdriveMTLSOptional
mTLS configuration for the origin connection. Cannot be used with VPC Service origins; TLS must be managed on the VPC Service.
CACertificateID stringOptional
Define CA certificate ID obtained after uploading CA cert.
Link to this property
MTLSCertificateID stringOptional
Define mTLS certificate ID obtained after uploading client cert.
Link to this property
Sslmode stringOptional
PostgreSQL accepts require, verify-ca, and verify-full. MySQL accepts REQUIRED, VERIFY_CA, and VERIFY_IDENTITY. The verify modes require a CA certificate; the require modes cannot be used with a CA certificate.
Link to this property
Link to this property
OriginConnectionLimit int64Optional
The (soft) maximum number of connections the Hyperdrive is allowed to make to the origin database.
Maximum allowed: 20 for free tier accounts, 100 for paid tier accounts. If not specified, defaults to 20 for free tier and 60 for paid tier. Certain Cloudflare-managed origins may be permitted a higher limit. Contact Cloudflare if you need a higher limit.
minimum5
Link to this property
RestartedOn TimeOptional
Defines the last time the Hyperdrive connection pool was explicitly restarted via the restart endpoint. Omitted if the pool has never been explicitly restarted.
formatdate-time
Link to this property
[Link to this property](<#(resource)%20hyperdrive%20%3E%20(model)%20hyperdrive%20%3E%20(schema)>)
#### HyperdriveConfigs
##### [List Hyperdrives](https://developers.cloudflare.com/api/go/resources/hyperdrive/subresources/configs/methods/list)
client.Hyperdrive.Configs.List(ctx, params) (\*V4PagePaginationArray\[[ConfigListResponse]()], error)
GET/accounts/{account\_id}/hyperdrive/configs
##### [Get Hyperdrive](https://developers.cloudflare.com/api/go/resources/hyperdrive/subresources/configs/methods/get)
client.Hyperdrive.Configs.Get(ctx, hyperdriveID, query) (\*[ConfigGetResponse](), error)
GET/accounts/{account\_id}/hyperdrive/configs/{hyperdrive\_id}
##### [Create Hyperdrive](https://developers.cloudflare.com/api/go/resources/hyperdrive/subresources/configs/methods/create)
client.Hyperdrive.Configs.New(ctx, params) (\*[ConfigNewResponse](), error)
POST/accounts/{account\_id}/hyperdrive/configs
##### [Replace Hyperdrive](https://developers.cloudflare.com/api/go/resources/hyperdrive/subresources/configs/methods/update)
client.Hyperdrive.Configs.Update(ctx, hyperdriveID, params) (\*[ConfigUpdateResponse](), error)
PUT/accounts/{account\_id}/hyperdrive/configs/{hyperdrive\_id}
##### [Update Hyperdrive](https://developers.cloudflare.com/api/go/resources/hyperdrive/subresources/configs/methods/edit)
client.Hyperdrive.Configs.Edit(ctx, hyperdriveID, params) (\*[ConfigEditResponse](), error)
PATCH/accounts/{account\_id}/hyperdrive/configs/{hyperdrive\_id}
##### [Restart Hyperdrive](https://developers.cloudflare.com/api/go/resources/hyperdrive/subresources/configs/methods/restart)
client.Hyperdrive.Configs.Restart(ctx, hyperdriveID, body) (\*[ConfigRestartResponse](), error)
POST/accounts/{account\_id}/hyperdrive/configs/{hyperdrive\_id}/restart
##### [Delete Hyperdrive](https://developers.cloudflare.com/api/go/resources/hyperdrive/subresources/configs/methods/delete)
client.Hyperdrive.Configs.Delete(ctx, hyperdriveID, body) (\*[ConfigDeleteResponse](), error)
DELETE/accounts/{account\_id}/hyperdrive/configs/{hyperdrive\_id}