--- title: Restart Hyperdrive --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [Hyperdrive](https://developers.cloudflare.com/api/resources/hyperdrive) [Configs](https://developers.cloudflare.com/api/resources/hyperdrive/subresources/configs) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Restart Hyperdrive POST/accounts/{account\_id}/hyperdrive/configs/{hyperdrive\_id}/restart Restarts the connection pool for the specified Hyperdrive configuration without changing its configuration. Existing connections are drained and a new pool is established at the edge. ##### 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` ##### P ath ParametersExpand Collapse account\_id: string Define configurations using a unique string identifier. maxLength32 [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(method)%20restart%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) hyperdrive\_id: string Define configurations using a unique string identifier. maxLength32 [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(method)%20restart%20%3E%20(params)%20default%20%3E%20(param)%20hyperdrive_id%20%3E%20(schema)>) ##### ReturnsExpand Collapse

errors: array of ResponseInfo { code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

[Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(method)%20restart%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)

messages: array of ResponseInfo { code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

[Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(method)%20restart%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)

result: object {id, caching, name, 7 more }

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

caching: object {disabled, max\_age, stale\_while\_revalidate }

disabled: boolean Defines whether caching is disabled. Link to this property max\_age: optional number Defines the maximum duration (in seconds) items persist in the cache. maximum3600 minimum1 Link to this property stale\_while\_revalidate: optional number 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: object {database, host, password, 3 more } or object {access\_client\_id, access\_client\_secret, database, 4 more } or object {database, password, scheme, 2 more } Combines database connection fields with exactly one supported network location.

One of the following:

PublicDatabase object {database, host, password, 3 more }

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: number 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: "postgres"or "postgresql"or "mysql" Specifies the URL scheme used to connect to your origin database.

One of the following: "postgres" Link to this property "postgresql" Link to this property "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

AccessProtectedDatabaseBehindCloudflareTunnel object {access\_client\_id, access\_client\_secret, database, 4 more }

access\_client\_id: string Defines the Client ID of the Access token to use when connecting to the origin database. Link to this property access\_client\_secret: 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: "postgres"or "postgresql"or "mysql" Specifies the URL scheme used to connect to your origin database.

One of the following: "postgres" Link to this property "postgresql" Link to this property "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

DatabaseReachableThroughAWorkersVPC object {database, password, scheme, 2 more }

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: "postgres"or "postgresql"or "mysql" Specifies the URL scheme used to connect to your origin database.

One of the following: "postgres" Link to this property "postgresql" Link to this property "mysql" Link to this property

Link to this property service\_id: 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 created\_on: optional string Defines the creation time of the Hyperdrive configuration. formatdate-time Link to this property

integration: optional object {database\_branch\_name, database\_name, organization\_name, 3 more } Connects to a PlanetScale database using credentials managed by Cloudflare. The Cloudflare account must already be linked to PlanetScale in the Hyperdrive dashboard.

database\_branch\_name: string The name of the PlanetScale database branch. maxLength2048 minLength1 Link to this property database\_name: string The name of the PlanetScale database. maxLength2048 minLength1 Link to this property organization\_name: string The name of the PlanetScale organization. maxLength2048 minLength1 Link to this property provider: "planetscale" The database integration provider used by this operation. Link to this property

scheme: "postgres"or "postgresql"or "mysql" Specifies the URL scheme used to connect to your origin database.

One of the following: "postgres" Link to this property "postgresql" Link to this property "mysql" Link to this property

Link to this property custom\_database\_name: optional string 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 modified\_on: optional string Defines the last modified time of the Hyperdrive configuration. formatdate-time Link to this property

mtls: optional object {ca\_certificate\_id, mtls\_certificate\_id, sslmode } mTLS configuration for the origin connection. Cannot be used with VPC Service origins; TLS must be managed on the VPC Service.

ca\_certificate\_id: optional string Define CA certificate ID obtained after uploading CA cert. Link to this property mtls\_certificate\_id: optional string Define mTLS certificate ID obtained after uploading client cert. Link to this property sslmode: optional string 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 origin\_connection\_limit: optional number 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 restarted\_on: optional string 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(method)%20restart%20%3E%20(network%20schema)%20%3E%20(property)%20result>) success: true Return the status of the API call success. [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(method)%20restart%20%3E%20(network%20schema)%20%3E%20(property)%20success>) ### Restart Hyperdrive HTTP HTTPTypeScriptPythonGoTerraform ``` curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/hyperdrive/configs/$HYPERDRIVE_ID/restart \ -X POST \ -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" ``` 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 } ```