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.
Servers
- https://api.cloudflare.com/client/v4
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
hyperdrive_id |
String | Yes |
The unique identifier of the Hyperdrive configuration. |
account_id |
String | Yes |
The Cloudflare account ID. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
Define configurations using a unique string identifier. |
mtls |
Object | No |
mTLS configuration for the origin connection. Cannot be used with VPC Service origins; TLS must be managed on the VPC Service. |
mtls.sslmode |
String | No |
Set SSL mode to 'require', 'verify-ca', or 'verify-full' to verify the CA. |
mtls.ca_certificate_id |
String | No |
Define CA certificate ID obtained after uploading CA cert. |
mtls.mtls_certificate_id |
String | No |
Define mTLS certificate ID obtained after uploading client cert. |
origin_connection_limit |
Integer | No |
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. |
name |
String | Yes |
The name of the Hyperdrive configuration. Used to identify the configuration in the Cloudflare dashboard and API. |
caching |
Object | No | |
created_on |
String | No |
Defines the creation time of the Hyperdrive configuration. |
origin |
Object | Yes | |
restarted_on |
String | No |
Defines the last time the Hyperdrive connection pool was explicitly restarted via the restart endpoint. Omitted if the pool has never been explicitly restarted. |
modified_on |
String | No |
Defines the last modified time of the Hyperdrive configuration. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.