--- title: Replace 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** # Replace Hyperdrive client.Hyperdrive.Configs.Update(ctx, hyperdriveID, params) (\*[ConfigUpdateResponse](), error) PUT/accounts/{account\_id}/hyperdrive/configs/{hyperdrive\_id} Replaces and returns the specified Hyperdrive configuration. The request must include the name and complete origin connection details. Omitted caching settings are reset to their defaults, while omitted mTLS settings and origin connection limits are preserved. Use the update operation to modify only selected fields. ##### 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 hyperdriveID string Define configurations using a unique string identifier. maxLength32 [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20hyperdrive_id%20%3E%20(schema)>)
params ConfigUpdateParams AccountID param.Field\[string] Path param: Define configurations using a unique string identifier. maxLength32 Link to this property Hyperdrive param.Field\[Hyperdrive] Body param Link to this property
[Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(method)%20update%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type ConfigUpdateResponse struct{…} ID string Define configurations using a unique string identifier. maxLength32 Link to this property
Caching ConfigUpdateResponseCaching 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 ConfigUpdateResponseOrigin Combines database connection fields with exactly one supported network location. One of the following:
type ConfigUpdateResponseOriginPublicDatabase struct{…} 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 ConfigUpdateResponseOriginPublicDatabaseScheme Specifies the URL scheme used to connect to your origin database. One of the following: const ConfigUpdateResponseOriginPublicDatabaseSchemePostgres ConfigUpdateResponseOriginPublicDatabaseScheme = "postgres" Link to this property const ConfigUpdateResponseOriginPublicDatabaseSchemePostgresql ConfigUpdateResponseOriginPublicDatabaseScheme = "postgresql" Link to this property const ConfigUpdateResponseOriginPublicDatabaseSchemeMysql ConfigUpdateResponseOriginPublicDatabaseScheme = "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 ConfigUpdateResponseOriginAccessProtectedDatabaseBehindCloudflareTunnel struct{…} 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 ConfigUpdateResponseOriginAccessProtectedDatabaseBehindCloudflareTunnelScheme Specifies the URL scheme used to connect to your origin database. One of the following: const ConfigUpdateResponseOriginAccessProtectedDatabaseBehindCloudflareTunnelSchemePostgres ConfigUpdateResponseOriginAccessProtectedDatabaseBehindCloudflareTunnelScheme = "postgres" Link to this property const ConfigUpdateResponseOriginAccessProtectedDatabaseBehindCloudflareTunnelSchemePostgresql ConfigUpdateResponseOriginAccessProtectedDatabaseBehindCloudflareTunnelScheme = "postgresql" Link to this property const ConfigUpdateResponseOriginAccessProtectedDatabaseBehindCloudflareTunnelSchemeMysql ConfigUpdateResponseOriginAccessProtectedDatabaseBehindCloudflareTunnelScheme = "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 ConfigUpdateResponseOriginDatabaseReachableThroughAWorkersVPC struct{…} 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 ConfigUpdateResponseOriginDatabaseReachableThroughAWorkersVPCScheme Specifies the URL scheme used to connect to your origin database. One of the following: const ConfigUpdateResponseOriginDatabaseReachableThroughAWorkersVPCSchemePostgres ConfigUpdateResponseOriginDatabaseReachableThroughAWorkersVPCScheme = "postgres" Link to this property const ConfigUpdateResponseOriginDatabaseReachableThroughAWorkersVPCSchemePostgresql ConfigUpdateResponseOriginDatabaseReachableThroughAWorkersVPCScheme = "postgresql" Link to this property const ConfigUpdateResponseOriginDatabaseReachableThroughAWorkersVPCSchemeMysql ConfigUpdateResponseOriginDatabaseReachableThroughAWorkersVPCScheme = "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 CreatedOn TimeOptional Defines the creation time of the Hyperdrive configuration. formatdate-time Link to this property
Integration ConfigUpdateResponseIntegrationOptional 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 ConfigUpdateResponseIntegrationProvider The database integration provider used by this operation. Link to this property
Scheme ConfigUpdateResponseIntegrationScheme Specifies the URL scheme used to connect to your origin database. One of the following: const ConfigUpdateResponseIntegrationSchemePostgres ConfigUpdateResponseIntegrationScheme = "postgres" Link to this property const ConfigUpdateResponseIntegrationSchemePostgresql ConfigUpdateResponseIntegrationScheme = "postgresql" Link to this property const ConfigUpdateResponseIntegrationSchemeMysql ConfigUpdateResponseIntegrationScheme = "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 ConfigUpdateResponseMTLSOptional 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.configs%20%3E%20(model)%20ConfigUpdateResponse%20%3E%20(schema)>) ### Replace 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.Update( context.TODO(), "023e105f4ecef8ad9ca31a8372d0c353", hyperdrive.ConfigUpdateParams{ AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), Hyperdrive: hyperdrive.HyperdriveParam{ Name: cloudflare.F("example-hyperdrive"), Origin: cloudflare.F[hyperdrive.HyperdriveOriginUnionParam](hyperdrive.HyperdriveOriginPublicDatabaseParam{ Database: cloudflare.F("postgres"), Host: cloudflare.F("database.example.com"), Password: cloudflare.F("password"), Port: cloudflare.F(int64(5432)), Scheme: cloudflare.F(hyperdrive.HyperdriveOriginPublicDatabaseSchemePostgres), 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 } ```