Hyperdrive

ModelsExpand Collapse

type Configuration interface{…}

Connect to a database through a Workers VPC Service. TLS settings (mTLS, sslmode) cannot be configured on the Hyperdrive when using a VPC Service origin; TLS must be managed on the VPC Service itself.

One of the following:

ConfigurationHyperdriveInternetOrigin

Host string

Defines the host (hostname or IP) of your origin database.

Port int64

Defines the port of your origin database. Defaults to 5432 for PostgreSQL or 3306 for MySQL if not specified.

Database stringOptional

Set the name of your origin database.

Password stringOptional

Set the password needed to access your origin database. The API never returns this write-only value.

Scheme ConfigurationHyperdriveInternetOriginSchemeOptional

Specifies the URL scheme used to connect to your origin database.

One of the following:

const ConfigurationHyperdriveInternetOriginSchemePostgres ConfigurationHyperdriveInternetOriginScheme = "postgres"

const ConfigurationHyperdriveInternetOriginSchemePostgresql ConfigurationHyperdriveInternetOriginScheme = "postgresql"

const ConfigurationHyperdriveInternetOriginSchemeMysql ConfigurationHyperdriveInternetOriginScheme = "mysql"

User stringOptional

Set the user of your origin database.

ConfigurationHyperdriveOverAccessOrigin

AccessClientID string

Defines the Client ID of the Access token to use when connecting to the origin database.

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.

Host string

Defines the host (hostname or IP) of your origin database.

Database stringOptional

Set the name of your origin database.

Password stringOptional

Set the password needed to access your origin database. The API never returns this write-only value.

Scheme ConfigurationHyperdriveOverAccessOriginSchemeOptional

Specifies the URL scheme used to connect to your origin database.

One of the following:

const ConfigurationHyperdriveOverAccessOriginSchemePostgres ConfigurationHyperdriveOverAccessOriginScheme = "postgres"

const ConfigurationHyperdriveOverAccessOriginSchemePostgresql ConfigurationHyperdriveOverAccessOriginScheme = "postgresql"

const ConfigurationHyperdriveOverAccessOriginSchemeMysql ConfigurationHyperdriveOverAccessOriginScheme = "mysql"

User stringOptional

Set the user of your origin database.

ConfigurationHyperdriveVPCServiceOrigin

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.

Database stringOptional

Set the name of your origin database.

Password stringOptional

Set the password needed to access your origin database. The API never returns this write-only value.

Scheme ConfigurationHyperdriveVPCServiceOriginSchemeOptional

Specifies the URL scheme used to connect to your origin database.

One of the following:

const ConfigurationHyperdriveVPCServiceOriginSchemePostgres ConfigurationHyperdriveVPCServiceOriginScheme = "postgres"

const ConfigurationHyperdriveVPCServiceOriginSchemePostgresql ConfigurationHyperdriveVPCServiceOriginScheme = "postgresql"

const ConfigurationHyperdriveVPCServiceOriginSchemeMysql ConfigurationHyperdriveVPCServiceOriginScheme = "mysql"

User stringOptional

Set the user of your origin database.

type Hyperdrive struct{…}

ID string

Define configurations using a unique string identifier.

maxLength32

Name string

The name of the Hyperdrive configuration. Used to identify the configuration in the Cloudflare dashboard and API.

Origin HyperdriveOrigin

One of the following:

type HyperdriveOriginPublicDatabase struct{…}

Database string

Set the name of your origin database.

Host string

Defines the host (hostname or IP) of your origin database.

Password string

Set the password needed to access your origin database. The API never returns this write-only value.

Port int64

Defines the port of your origin database. Defaults to 5432 for PostgreSQL or 3306 for MySQL if not specified.

Scheme HyperdriveOriginPublicDatabaseScheme

Specifies the URL scheme used to connect to your origin database.

One of the following:

const HyperdriveOriginPublicDatabaseSchemePostgres HyperdriveOriginPublicDatabaseScheme = "postgres"

const HyperdriveOriginPublicDatabaseSchemePostgresql HyperdriveOriginPublicDatabaseScheme = "postgresql"

const HyperdriveOriginPublicDatabaseSchemeMysql HyperdriveOriginPublicDatabaseScheme = "mysql"

User string

Set the user of your origin database.

type HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnel struct{…}

AccessClientID string

Defines the Client ID of the Access token to use when connecting to the origin database.

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.

Database string

Set the name of your origin database.

Host string

Defines the host (hostname or IP) of your origin database.

Password string

Set the password needed to access your origin database. The API never returns this write-only value.

Scheme HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnelScheme

Specifies the URL scheme used to connect to your origin database.

One of the following:

const HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnelSchemePostgres HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnelScheme = "postgres"

const HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnelSchemePostgresql HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnelScheme = "postgresql"

const HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnelSchemeMysql HyperdriveOriginAccessProtectedDatabaseBehindCloudflareTunnelScheme = "mysql"

User string

Set the user of your origin database.

type HyperdriveOriginDatabaseReachableThroughAWorkersVPC struct{…}

Database string

Set the name of your origin database.

Password string

Set the password needed to access your origin database. The API never returns this write-only value.

Scheme HyperdriveOriginDatabaseReachableThroughAWorkersVPCScheme

Specifies the URL scheme used to connect to your origin database.

One of the following:

const HyperdriveOriginDatabaseReachableThroughAWorkersVPCSchemePostgres HyperdriveOriginDatabaseReachableThroughAWorkersVPCScheme = "postgres"

const HyperdriveOriginDatabaseReachableThroughAWorkersVPCSchemePostgresql HyperdriveOriginDatabaseReachableThroughAWorkersVPCScheme = "postgresql"

const HyperdriveOriginDatabaseReachableThroughAWorkersVPCSchemeMysql HyperdriveOriginDatabaseReachableThroughAWorkersVPCScheme = "mysql"

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.

User string

Set the user of your origin database.

Caching HyperdriveCachingOptional

One of the following:

type HyperdriveCachingHyperdriveHyperdriveCachingCommon struct{…}

Disabled boolOptional

Set to true to disable caching of SQL responses. Default is false.

type HyperdriveCachingHyperdriveHyperdriveCachingEnabled struct{…}

Disabled boolOptional

Set to true to disable caching of SQL responses. Default is false.

MaxAge int64Optional

Specify the maximum duration (in seconds) items should persist in the cache. Defaults to 60 seconds if not specified.

StaleWhileRevalidate int64Optional

Specify the number of seconds the cache may serve a stale response. Defaults to 15 seconds if not specified.

CreatedOn TimeOptional

Defines the creation time of the Hyperdrive configuration.

formatdate-time

ModifiedOn TimeOptional

Defines the last modified time of the Hyperdrive configuration.

formatdate-time

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.

MTLSCertificateID stringOptional

Define mTLS certificate ID obtained after uploading client cert.

Sslmode stringOptional

Set SSL mode to ‘require’, ‘verify-ca’, or ‘verify-full’ to verify the CA.

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. Contact Cloudflare if you need a higher limit.

maximum100

minimum5

Hyperdrive

ModelsExpand Collapse

HyperdriveConfigs

List Hyperdrives

Get Hyperdrive

Create Hyperdrive

Update Hyperdrive

Patch Hyperdrive

Delete Hyperdrive