--- title: Configs --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Hyperdrive](https://developers.cloudflare.com/api/typescript/resources/hyperdrive) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Configs ##### [List Hyperdrives](https://developers.cloudflare.com/api/typescript/resources/hyperdrive/subresources/configs/methods/list) client.hyperdrive.configs.list(ConfigListParams {account\_id, page, per\_page } params, RequestOptionsoptions?): V4PagePaginationArray< [ConfigListResponse]() {id, caching, name, 7 more } > GET/accounts/{account\_id}/hyperdrive/configs ##### [Get Hyperdrive](https://developers.cloudflare.com/api/typescript/resources/hyperdrive/subresources/configs/methods/get) client.hyperdrive.configs.get(stringhyperdriveID, ConfigGetParams {account\_id } params, RequestOptionsoptions?): [ConfigGetResponse]() {id, caching, name, 7 more } GET/accounts/{account\_id}/hyperdrive/configs/{hyperdrive\_id} ##### [Create Hyperdrive](https://developers.cloudflare.com/api/typescript/resources/hyperdrive/subresources/configs/methods/create) client.hyperdrive.configs.create(ConfigCreateParamsparams, RequestOptionsoptions?): [ConfigCreateResponse]() {id, caching, name, 7 more } POST/accounts/{account\_id}/hyperdrive/configs ##### [Replace Hyperdrive](https://developers.cloudflare.com/api/typescript/resources/hyperdrive/subresources/configs/methods/update) client.hyperdrive.configs.update(stringhyperdriveID, ConfigUpdateParams {account\_id, name, origin, 3 more } params, RequestOptionsoptions?): [ConfigUpdateResponse]() {id, caching, name, 7 more } PUT/accounts/{account\_id}/hyperdrive/configs/{hyperdrive\_id} ##### [Update Hyperdrive](https://developers.cloudflare.com/api/typescript/resources/hyperdrive/subresources/configs/methods/edit) client.hyperdrive.configs.edit(stringhyperdriveID, ConfigEditParams {account\_id, caching, mtls, 3 more } params, RequestOptionsoptions?): [ConfigEditResponse]() {id, caching, name, 7 more } PATCH/accounts/{account\_id}/hyperdrive/configs/{hyperdrive\_id} ##### [Restart Hyperdrive](https://developers.cloudflare.com/api/typescript/resources/hyperdrive/subresources/configs/methods/restart) client.hyperdrive.configs.restart(stringhyperdriveID, ConfigRestartParams {account\_id } params, RequestOptionsoptions?): [ConfigRestartResponse]() {id, caching, name, 7 more } POST/accounts/{account\_id}/hyperdrive/configs/{hyperdrive\_id}/restart ##### [Delete Hyperdrive](https://developers.cloudflare.com/api/typescript/resources/hyperdrive/subresources/configs/methods/delete) client.hyperdrive.configs.delete(stringhyperdriveID, ConfigDeleteParams {account\_id } params, RequestOptionsoptions?): [ConfigDeleteResponse]()| null DELETE/accounts/{account\_id}/hyperdrive/configs/{hyperdrive\_id} ##### ModelsExpand Collapse
ConfigListResponse {id, caching, name, 7 more } id: string Define configurations using a unique string identifier. maxLength32 Link to this property
caching: Caching {disabled, max\_age, stale\_while\_revalidate } disabled: boolean Defines whether caching is disabled. Link to this property max\_age?: number Defines the maximum duration (in seconds) items persist in the cache. maximum3600 minimum1 Link to this property stale\_while\_revalidate?: 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: PublicDatabase {database, host, password, 3 more } | AccessProtectedDatabaseBehindCloudflareTunnel {access\_client\_id, access\_client\_secret, database, 4 more } | DatabaseReachableThroughAWorkersVPC {database, password, scheme, 2 more } Combines database connection fields with exactly one supported network location. One of the following:
PublicDatabase {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"| "postgresql"| "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 {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"| "postgresql"| "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 {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"| "postgresql"| "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?: string Defines the creation time of the Hyperdrive configuration. formatdate-time Link to this property
integration?: Integration {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"| "postgresql"| "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?: 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?: string Defines the last modified time of the Hyperdrive configuration. formatdate-time Link to this property
mtls?: MTLS {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?: string Define CA certificate ID obtained after uploading CA cert. Link to this property mtls\_certificate\_id?: string Define mTLS certificate ID obtained after uploading client cert. Link to this property sslmode?: 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?: 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?: string| null 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)%20config_list_response%20%3E%20(schema)>)
ConfigGetResponse {id, caching, name, 7 more } id: string Define configurations using a unique string identifier. maxLength32 Link to this property
caching: Caching {disabled, max\_age, stale\_while\_revalidate } disabled: boolean Defines whether caching is disabled. Link to this property max\_age?: number Defines the maximum duration (in seconds) items persist in the cache. maximum3600 minimum1 Link to this property stale\_while\_revalidate?: 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: PublicDatabase {database, host, password, 3 more } | AccessProtectedDatabaseBehindCloudflareTunnel {access\_client\_id, access\_client\_secret, database, 4 more } | DatabaseReachableThroughAWorkersVPC {database, password, scheme, 2 more } Combines database connection fields with exactly one supported network location. One of the following:
PublicDatabase {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"| "postgresql"| "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 {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"| "postgresql"| "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 {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"| "postgresql"| "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?: string Defines the creation time of the Hyperdrive configuration. formatdate-time Link to this property
integration?: Integration {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"| "postgresql"| "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?: 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?: string Defines the last modified time of the Hyperdrive configuration. formatdate-time Link to this property
mtls?: MTLS {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?: string Define CA certificate ID obtained after uploading CA cert. Link to this property mtls\_certificate\_id?: string Define mTLS certificate ID obtained after uploading client cert. Link to this property sslmode?: 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?: 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?: string| null 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)%20config_get_response%20%3E%20(schema)>)
ConfigCreateResponse {id, caching, name, 7 more } id: string Define configurations using a unique string identifier. maxLength32 Link to this property
caching: Caching {disabled, max\_age, stale\_while\_revalidate } disabled: boolean Defines whether caching is disabled. Link to this property max\_age?: number Defines the maximum duration (in seconds) items persist in the cache. maximum3600 minimum1 Link to this property stale\_while\_revalidate?: 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: PublicDatabase {database, host, password, 3 more } | AccessProtectedDatabaseBehindCloudflareTunnel {access\_client\_id, access\_client\_secret, database, 4 more } | DatabaseReachableThroughAWorkersVPC {database, password, scheme, 2 more } Combines database connection fields with exactly one supported network location. One of the following:
PublicDatabase {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"| "postgresql"| "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 {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"| "postgresql"| "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 {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"| "postgresql"| "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?: string Defines the creation time of the Hyperdrive configuration. formatdate-time Link to this property
integration?: Integration {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"| "postgresql"| "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?: 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?: string Defines the last modified time of the Hyperdrive configuration. formatdate-time Link to this property
mtls?: MTLS {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?: string Define CA certificate ID obtained after uploading CA cert. Link to this property mtls\_certificate\_id?: string Define mTLS certificate ID obtained after uploading client cert. Link to this property sslmode?: 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?: 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?: string| null 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)%20config_create_response%20%3E%20(schema)>)
ConfigUpdateResponse {id, caching, name, 7 more } id: string Define configurations using a unique string identifier. maxLength32 Link to this property
caching: Caching {disabled, max\_age, stale\_while\_revalidate } disabled: boolean Defines whether caching is disabled. Link to this property max\_age?: number Defines the maximum duration (in seconds) items persist in the cache. maximum3600 minimum1 Link to this property stale\_while\_revalidate?: 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: PublicDatabase {database, host, password, 3 more } | AccessProtectedDatabaseBehindCloudflareTunnel {access\_client\_id, access\_client\_secret, database, 4 more } | DatabaseReachableThroughAWorkersVPC {database, password, scheme, 2 more } Combines database connection fields with exactly one supported network location. One of the following:
PublicDatabase {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"| "postgresql"| "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 {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"| "postgresql"| "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 {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"| "postgresql"| "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?: string Defines the creation time of the Hyperdrive configuration. formatdate-time Link to this property
integration?: Integration {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"| "postgresql"| "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?: 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?: string Defines the last modified time of the Hyperdrive configuration. formatdate-time Link to this property
mtls?: MTLS {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?: string Define CA certificate ID obtained after uploading CA cert. Link to this property mtls\_certificate\_id?: string Define mTLS certificate ID obtained after uploading client cert. Link to this property sslmode?: 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?: 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?: string| null 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)%20config_update_response%20%3E%20(schema)>)
ConfigEditResponse {id, caching, name, 7 more } id: string Define configurations using a unique string identifier. maxLength32 Link to this property
caching: Caching {disabled, max\_age, stale\_while\_revalidate } disabled: boolean Defines whether caching is disabled. Link to this property max\_age?: number Defines the maximum duration (in seconds) items persist in the cache. maximum3600 minimum1 Link to this property stale\_while\_revalidate?: 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: PublicDatabase {database, host, password, 3 more } | AccessProtectedDatabaseBehindCloudflareTunnel {access\_client\_id, access\_client\_secret, database, 4 more } | DatabaseReachableThroughAWorkersVPC {database, password, scheme, 2 more } Combines database connection fields with exactly one supported network location. One of the following:
PublicDatabase {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"| "postgresql"| "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 {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"| "postgresql"| "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 {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"| "postgresql"| "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?: string Defines the creation time of the Hyperdrive configuration. formatdate-time Link to this property
integration?: Integration {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"| "postgresql"| "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?: 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?: string Defines the last modified time of the Hyperdrive configuration. formatdate-time Link to this property
mtls?: MTLS {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?: string Define CA certificate ID obtained after uploading CA cert. Link to this property mtls\_certificate\_id?: string Define mTLS certificate ID obtained after uploading client cert. Link to this property sslmode?: 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?: 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?: string| null 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)%20config_edit_response%20%3E%20(schema)>)
ConfigRestartResponse {id, caching, name, 7 more } id: string Define configurations using a unique string identifier. maxLength32 Link to this property
caching: Caching {disabled, max\_age, stale\_while\_revalidate } disabled: boolean Defines whether caching is disabled. Link to this property max\_age?: number Defines the maximum duration (in seconds) items persist in the cache. maximum3600 minimum1 Link to this property stale\_while\_revalidate?: 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: PublicDatabase {database, host, password, 3 more } | AccessProtectedDatabaseBehindCloudflareTunnel {access\_client\_id, access\_client\_secret, database, 4 more } | DatabaseReachableThroughAWorkersVPC {database, password, scheme, 2 more } Combines database connection fields with exactly one supported network location. One of the following:
PublicDatabase {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"| "postgresql"| "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 {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"| "postgresql"| "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 {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"| "postgresql"| "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?: string Defines the creation time of the Hyperdrive configuration. formatdate-time Link to this property
integration?: Integration {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"| "postgresql"| "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?: 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?: string Defines the last modified time of the Hyperdrive configuration. formatdate-time Link to this property
mtls?: MTLS {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?: string Define CA certificate ID obtained after uploading CA cert. Link to this property mtls\_certificate\_id?: string Define mTLS certificate ID obtained after uploading client cert. Link to this property sslmode?: 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?: 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?: string| null 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)%20config_restart_response%20%3E%20(schema)>) ConfigDeleteResponse = unknown [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(model)%20config_delete_response%20%3E%20(schema)>)