Cloudflare API | Hyperdrive › Configs › Get Hyperdrive

API Reference

Account & User Management

Resource Sharing

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Network Monitoring

Observability

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Content Scanning

Leaked Credential Checks

Storage & Databases

Create Hyperdrive

Delete Hyperdrive

Patch Hyperdrive

List Hyperdrives

Update Hyperdrive

Threat Intelligence

Brand Protection

Workers & Pages

Durable Objects

Workers For Platforms

Shared

Hyperdrive

hyperdrive

Domain types

Configuration = { host, port, database, 3 more... } | { access_client_id, access_client_secret, host, 4 more... }

Hyperdrive = { id, name, origin, 1 more... }

Configs

hyperdrive.configs

Methods

Create Hyperdrive -> Envelope<

>

post/accounts/{account_id}/hyperdrive/configs

Creates and returns a new Hyperdrive configuration.

Delete Hyperdrive -> Envelope<unknown>

delete/accounts/{account_id}/hyperdrive/configs/{hyperdrive_id}

Deletes the specified Hyperdrive.

Patch Hyperdrive -> Envelope<

>

patch/accounts/{account_id}/hyperdrive/configs/{hyperdrive_id}

Patches and returns the specified Hyperdrive configuration. Custom caching settings are not kept if caching is disabled.

Get Hyperdrive -> Envelope<

>

get/accounts/{account_id}/hyperdrive/configs/{hyperdrive_id}

Returns the specified Hyperdrive configuration.

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Hyperdrive Write Hyperdrive Read

Parameters

account_id: string

(maxLength: 32)

Identifier

hyperdrive_id: string

(maxLength: 32)

Identifier

Response fields

errors: Array<

>

messages: Array<

>

result:

success: true

Whether the API call was successful

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/hyperdrive/configs/$HYPERDRIVE_ID \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "name": "example-hyperdrive",
    "origin": {
      "database": "postgres",
      "host": "database.example.com",
      "password": "password",
      "port": 5432,
      "scheme": "postgres",
      "user": "postgres"
    },
    "caching": {
      "disabled": true
    }
  },
  "success": true
}

List Hyperdrives -> SinglePage<

>

get/accounts/{account_id}/hyperdrive/configs

Returns a list of Hyperdrives

Update Hyperdrive -> Envelope<

>

put/accounts/{account_id}/hyperdrive/configs/{hyperdrive_id}

Updates and returns the specified Hyperdrive configuration.