--- title: Create Hyperdrive --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Hyperdrive](https://developers.cloudflare.com/api/python/resources/hyperdrive) [Configs](https://developers.cloudflare.com/api/python/resources/hyperdrive/subresources/configs) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create Hyperdrive hyperdrive.configs.create(ConfigCreateParams\*\*kwargs) -> [ConfigCreateResponse]() 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 account\_id: str Define configurations using a unique string identifier. maxLength32 [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20account_id%20%3E%20(schema)>) name: str The name of the Hyperdrive configuration. Used to identify the configuration in the Cloudflare dashboard and API. maxLength2048 [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20name%20%3E%20(schema)>)
origin: HyperdriveHyperdriveConfigCreateWithOriginOrigin Combines database connection fields with exactly one supported network location. One of the following:
class HyperdriveHyperdriveConfigCreateWithOriginOriginPublicDatabase: … database: str Set the name of your origin database. maxLength2048 Link to this property host: str 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: str Set the password needed to access your origin database. The API never returns this write-only value. maxLength2048 Link to this property port: int 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: Literal\["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: str Set the user of your origin database. maxLength2048 Link to this property
Link to this property
class HyperdriveHyperdriveConfigCreateWithOriginOriginAccessProtectedDatabaseBehindCloudflareTunnel: … access\_client\_id: str Defines the Client ID of the Access token to use when connecting to the origin database. Link to this property access\_client\_secret: str 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: str Set the name of your origin database. maxLength2048 Link to this property host: str Defines the host (hostname or IP) of your origin database. Link to this property password: str Set the password needed to access your origin database. The API never returns this write-only value. maxLength2048 Link to this property
scheme: Literal\["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: str Set the user of your origin database. maxLength2048 Link to this property
Link to this property
class HyperdriveHyperdriveConfigCreateWithOriginOriginDatabaseReachableThroughAWorkersVPC: … database: str Set the name of your origin database. maxLength2048 Link to this property password: str Set the password needed to access your origin database. The API never returns this write-only value. maxLength2048 Link to this property
scheme: Literal\["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: str 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: str Set the user of your origin database. maxLength2048 Link to this property
Link to this property
[Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20origin%20%3E%20(schema)>)
caching: Optional\[HyperdriveHyperdriveConfigCreateWithOriginCaching] One of the following:
class HyperdriveHyperdriveConfigCreateWithOriginCachingHyperdriveHyperdriveCachingCreateDisabled: … disabled: Literal\[true] Link to this property max\_age: Optional\[int] Link to this property stale\_while\_revalidate: Optional\[int] Link to this property
Link to this property
class HyperdriveHyperdriveConfigCreateWithOriginCachingHyperdriveHyperdriveCachingCreateEnabled: … disabled: Optional\[Literal\[false]] Link to this property max\_age: Optional\[int] 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 stale\_while\_revalidate: Optional\[int] 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](<#(resource)%20hyperdrive.configs%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20caching%20%3E%20(schema)>) integration: Optional\[object] [Link to this property](<#(resource)%20hyperdrive.configs%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20integration%20%3E%20(schema)>)
mtls: Optional\[HyperdriveHyperdriveConfigCreateWithOriginMTLS] 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\[str] Define CA certificate ID obtained after uploading CA cert. Link to this property mtls\_certificate\_id: Optional\[str] Define mTLS certificate ID obtained after uploading client cert. Link to this property sslmode: Optional\[str] 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](<#(resource)%20hyperdrive.configs%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20mtls%20%3E%20(schema)>) origin\_connection\_limit: Optional\[int] 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](<#(resource)%20hyperdrive.configs%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20origin_connection_limit%20%3E%20(schema)>) ##### ReturnsExpand Collapse
class ConfigCreateResponse: … id: str Define configurations using a unique string identifier. maxLength32 Link to this property
caching: Caching disabled: bool Defines whether caching is disabled. Link to this property max\_age: Optional\[int] Defines the maximum duration (in seconds) items persist in the cache. maximum3600 minimum1 Link to this property stale\_while\_revalidate: Optional\[int] Defines the number of seconds the cache may serve a stale response. minimum0 Link to this property
Link to this property name: str The name of the Hyperdrive configuration. Used to identify the configuration in the Cloudflare dashboard and API. maxLength2048 Link to this property
origin: Origin Combines database connection fields with exactly one supported network location. One of the following:
class OriginPublicDatabase: … database: str Set the name of your origin database. maxLength2048 Link to this property host: str 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: str Set the password needed to access your origin database. The API never returns this write-only value. maxLength2048 Link to this property port: int 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: Literal\["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: str Set the user of your origin database. maxLength2048 Link to this property
Link to this property
class OriginAccessProtectedDatabaseBehindCloudflareTunnel: … access\_client\_id: str Defines the Client ID of the Access token to use when connecting to the origin database. Link to this property access\_client\_secret: str 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: str Set the name of your origin database. maxLength2048 Link to this property host: str Defines the host (hostname or IP) of your origin database. Link to this property password: str Set the password needed to access your origin database. The API never returns this write-only value. maxLength2048 Link to this property
scheme: Literal\["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: str Set the user of your origin database. maxLength2048 Link to this property
Link to this property
class OriginDatabaseReachableThroughAWorkersVPC: … database: str Set the name of your origin database. maxLength2048 Link to this property password: str Set the password needed to access your origin database. The API never returns this write-only value. maxLength2048 Link to this property
scheme: Literal\["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: str 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: str Set the user of your origin database. maxLength2048 Link to this property
Link to this property
Link to this property created\_on: Optional\[datetime] Defines the creation time of the Hyperdrive configuration. formatdate-time Link to this property
integration: Optional\[Integration] 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: str The name of the PlanetScale database branch. maxLength2048 minLength1 Link to this property database\_name: str The name of the PlanetScale database. maxLength2048 minLength1 Link to this property organization\_name: str The name of the PlanetScale organization. maxLength2048 minLength1 Link to this property provider: Literal\["planetscale"] The database integration provider used by this operation. Link to this property
scheme: Literal\["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: Optional\[str] 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\[datetime] Defines the last modified time of the Hyperdrive configuration. formatdate-time Link to this property
mtls: Optional\[MTLS] 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\[str] Define CA certificate ID obtained after uploading CA cert. Link to this property mtls\_certificate\_id: Optional\[str] Define mTLS certificate ID obtained after uploading client cert. Link to this property sslmode: Optional\[str] 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\[int] 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\[datetime] 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)>) ### Create Hyperdrive Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) config = client.hyperdrive.configs.create( account_id="023e105f4ecef8ad9ca31a8372d0c353", name="example-hyperdrive", origin={ "database": "postgres", "host": "database.example.com", "password": "password", "port": 5432, "scheme": "postgres", "user": "postgres", }, ) print(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 } ```