--- title: Create Hyperdrive --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Hyperdrive](https://developers.cloudflare.com/api/go/resources/hyperdrive) [Configs](https://developers.cloudflare.com/api/go/resources/hyperdrive/subresources/configs) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create Hyperdrive client.Hyperdrive.Configs.New(ctx, params) (\*[ConfigNewResponse](), error) POST/accounts/{account\_id}/hyperdrive/configs Creates and returns a new Hyperdrive configuration. For a PlanetScale integration, the Cloudflare account must already be linked to PlanetScale in the Hyperdrive dashboard. ##### 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) `Hyperdrive Write` ##### ParametersExpand Collapse

params ConfigNewParams

AccountID param.Field\[string] Path param: Define configurations using a unique string identifier. maxLength32 Link to this property Name param.Field\[string] Body param: The name of the Hyperdrive configuration. Used to identify the configuration in the Cloudflare dashboard and API. maxLength2048 Link to this property

Origin param.Field\[ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOrigin] Body param: Combines database connection fields with exactly one supported network location.

ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOriginPublicDatabase

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 ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOriginPublicDatabaseScheme Specifies the URL scheme used to connect to your origin database.

One of the following: const ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOriginPublicDatabaseSchemePostgres ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOriginPublicDatabaseScheme = "postgres" Link to this property const ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOriginPublicDatabaseSchemePostgresql ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOriginPublicDatabaseScheme = "postgresql" Link to this property const ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOriginPublicDatabaseSchemeMysql ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOriginPublicDatabaseScheme = "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

ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOriginAccessProtectedDatabaseBehindCloudflareTunnel

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 ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOriginAccessProtectedDatabaseBehindCloudflareTunnelScheme Specifies the URL scheme used to connect to your origin database.

One of the following: const ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOriginAccessProtectedDatabaseBehindCloudflareTunnelSchemePostgres ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOriginAccessProtectedDatabaseBehindCloudflareTunnelScheme = "postgres" Link to this property const ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOriginAccessProtectedDatabaseBehindCloudflareTunnelSchemePostgresql ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOriginAccessProtectedDatabaseBehindCloudflareTunnelScheme = "postgresql" Link to this property const ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOriginAccessProtectedDatabaseBehindCloudflareTunnelSchemeMysql ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOriginAccessProtectedDatabaseBehindCloudflareTunnelScheme = "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

ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOriginDatabaseReachableThroughAWorkersVPC

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 ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOriginDatabaseReachableThroughAWorkersVPCScheme Specifies the URL scheme used to connect to your origin database.

One of the following: const ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOriginDatabaseReachableThroughAWorkersVPCSchemePostgres ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOriginDatabaseReachableThroughAWorkersVPCScheme = "postgres" Link to this property const ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOriginDatabaseReachableThroughAWorkersVPCSchemePostgresql ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOriginDatabaseReachableThroughAWorkersVPCScheme = "postgresql" Link to this property const ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOriginDatabaseReachableThroughAWorkersVPCSchemeMysql ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginOriginDatabaseReachableThroughAWorkersVPCScheme = "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

Caching param.Field\[ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginCaching]Optional Body param

ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginCachingHyperdriveHyperdriveCachingCreateDisabled

Disabled ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginCachingHyperdriveHyperdriveCachingCreateDisabledDisabled Link to this property MaxAge int64Optional Link to this property StaleWhileRevalidate int64Optional Link to this property

Link to this property

ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginCachingHyperdriveHyperdriveCachingCreateEnabled

Disabled ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginCachingHyperdriveHyperdriveCachingCreateEnabledDisabledOptional 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. maximum3600 minimum1 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. minimum0 Link to this property

Link to this property

Link to this property Integration param.Field\[unknown]Optional Body param Link to this property

MTLS param.Field\[ConfigNewParamsHyperdriveHyperdriveConfigCreateWithOriginMTLS]Optional Body param: 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 param.Field\[int64]Optional Body param: 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

[Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(method)%20create%20%3E%20(params)%200>) ##### ReturnsExpand Collapse

type ConfigNewResponse struct{…}

ID string Define configurations using a unique string identifier. maxLength32 Link to this property

Caching ConfigNewResponseCaching

Disabled bool Defines whether caching is disabled. Link to this property MaxAge int64Optional Defines the maximum duration (in seconds) items persist in the cache. maximum3600 minimum1 Link to this property StaleWhileRevalidate int64Optional Defines the number of seconds the cache may serve a stale response. minimum0 Link to this property

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 ConfigNewResponseOrigin Combines database connection fields with exactly one supported network location.

One of the following:

type ConfigNewResponseOriginPublicDatabase struct{…}

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

One of the following: const ConfigNewResponseOriginPublicDatabaseSchemePostgres ConfigNewResponseOriginPublicDatabaseScheme = "postgres" Link to this property const ConfigNewResponseOriginPublicDatabaseSchemePostgresql ConfigNewResponseOriginPublicDatabaseScheme = "postgresql" Link to this property const ConfigNewResponseOriginPublicDatabaseSchemeMysql ConfigNewResponseOriginPublicDatabaseScheme = "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

type ConfigNewResponseOriginAccessProtectedDatabaseBehindCloudflareTunnel struct{…}

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

One of the following: const ConfigNewResponseOriginAccessProtectedDatabaseBehindCloudflareTunnelSchemePostgres ConfigNewResponseOriginAccessProtectedDatabaseBehindCloudflareTunnelScheme = "postgres" Link to this property const ConfigNewResponseOriginAccessProtectedDatabaseBehindCloudflareTunnelSchemePostgresql ConfigNewResponseOriginAccessProtectedDatabaseBehindCloudflareTunnelScheme = "postgresql" Link to this property const ConfigNewResponseOriginAccessProtectedDatabaseBehindCloudflareTunnelSchemeMysql ConfigNewResponseOriginAccessProtectedDatabaseBehindCloudflareTunnelScheme = "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

type ConfigNewResponseOriginDatabaseReachableThroughAWorkersVPC struct{…}

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

One of the following: const ConfigNewResponseOriginDatabaseReachableThroughAWorkersVPCSchemePostgres ConfigNewResponseOriginDatabaseReachableThroughAWorkersVPCScheme = "postgres" Link to this property const ConfigNewResponseOriginDatabaseReachableThroughAWorkersVPCSchemePostgresql ConfigNewResponseOriginDatabaseReachableThroughAWorkersVPCScheme = "postgresql" Link to this property const ConfigNewResponseOriginDatabaseReachableThroughAWorkersVPCSchemeMysql ConfigNewResponseOriginDatabaseReachableThroughAWorkersVPCScheme = "mysql" 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

Integration ConfigNewResponseIntegrationOptional Connects to a PlanetScale database using credentials managed by Cloudflare. The Cloudflare account must already be linked to PlanetScale in the Hyperdrive dashboard.

DatabaseBranchName string The name of the PlanetScale database branch. maxLength2048 minLength1 Link to this property DatabaseName string The name of the PlanetScale database. maxLength2048 minLength1 Link to this property OrganizationName string The name of the PlanetScale organization. maxLength2048 minLength1 Link to this property Provider ConfigNewResponseIntegrationProvider The database integration provider used by this operation. Link to this property

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

One of the following: const ConfigNewResponseIntegrationSchemePostgres ConfigNewResponseIntegrationScheme = "postgres" Link to this property const ConfigNewResponseIntegrationSchemePostgresql ConfigNewResponseIntegrationScheme = "postgresql" Link to this property const ConfigNewResponseIntegrationSchemeMysql ConfigNewResponseIntegrationScheme = "mysql" Link to this property

Link to this property CustomDatabaseName stringOptional The database name to use when connecting. Defaults to postgres for PostgreSQL and mysql for MySQL. maxLength2048 Link to this property

Link to this property ModifiedOn TimeOptional Defines the last modified time of the Hyperdrive configuration. formatdate-time Link to this property

MTLS ConfigNewResponseMTLSOptional mTLS configuration for the origin connection. Cannot be used with VPC Service origins; TLS must be managed on the VPC Service.

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.configs%20%3E%20(model)%20ConfigNewResponse%20%3E%20(schema)>) ### Create Hyperdrive Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/hyperdrive" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) config, err := client.Hyperdrive.Configs.New(context.TODO(), hyperdrive.ConfigNewParams{ AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), Body: hyperdrive.ConfigNewParamsBodyHyperdriveHyperdriveConfigCreateWithOrigin{ Name: cloudflare.F("example-hyperdrive"), Origin: cloudflare.F[hyperdrive.ConfigNewParamsBodyHyperdriveHyperdriveConfigCreateWithOriginOriginUnion](hyperdrive.ConfigNewParamsBodyHyperdriveHyperdriveConfigCreateWithOriginOriginPublicDatabase{ Database: cloudflare.F("postgres"), Host: cloudflare.F("database.example.com"), Password: cloudflare.F("password"), Port: cloudflare.F(int64(5432)), Scheme: cloudflare.F(hyperdrive.ConfigNewParamsBodyHyperdriveHyperdriveConfigCreateWithOriginOriginPublicDatabaseSchemePostgres), User: cloudflare.F("postgres"), }), }, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", config.ID) } ``` 200 example ``` { "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": { "id": "023e105f4ecef8ad9ca31a8372d0c353", "caching": { "disabled": true, "max_age": 1, "stale_while_revalidate": 0 }, "name": "example-hyperdrive", "origin": { "database": "postgres", "host": "database.example.com", "port": 5432, "scheme": "postgres", "user": "postgres" }, "created_on": "2017-01-01T00:00:00Z", "integration": { "database_branch_name": "x", "database_name": "x", "organization_name": "x", "provider": "planetscale", "scheme": "postgres", "custom_database_name": "custom_database_name" }, "modified_on": "2017-01-01T00:00:00Z", "mtls": { "ca_certificate_id": "00000000-0000-0000-0000-0000000000", "mtls_certificate_id": "00000000-0000-0000-0000-0000000000", "sslmode": "verify-full" }, "origin_connection_limit": 60, "restarted_on": "2017-01-01T00:00:00Z" }, "success": true } ``` ##### Returns Examples 200 example ``` { "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": { "id": "023e105f4ecef8ad9ca31a8372d0c353", "caching": { "disabled": true, "max_age": 1, "stale_while_revalidate": 0 }, "name": "example-hyperdrive", "origin": { "database": "postgres", "host": "database.example.com", "port": 5432, "scheme": "postgres", "user": "postgres" }, "created_on": "2017-01-01T00:00:00Z", "integration": { "database_branch_name": "x", "database_name": "x", "organization_name": "x", "provider": "planetscale", "scheme": "postgres", "custom_database_name": "custom_database_name" }, "modified_on": "2017-01-01T00:00:00Z", "mtls": { "ca_certificate_id": "00000000-0000-0000-0000-0000000000", "mtls_certificate_id": "00000000-0000-0000-0000-0000000000", "sslmode": "verify-full" }, "origin_connection_limit": 60, "restarted_on": "2017-01-01T00:00:00Z" }, "success": true } ```