Create Hyperdrive
client.hyperdrive.configs.create(ConfigCreateParamsparams, RequestOptionsoptions?): ConfigCreateResponse { id, caching, name, 7 more }
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:
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
Example:
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Example:
Accepted Permissions (at least one required)
Create Hyperdrive
import Cloudflare from 'cloudflare';
const client = new Cloudflare({
apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});
const config = await 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',
},
});
console.log(config.id);{
"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
{
"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
}