Returns a list of Hyperdrives
/accounts/{account_identifier}/hyperdrive/configs
get
Hyperdrive
list-hyperdrive
null{
"enum": [
"com.cloudflare.edge.hyperdrive.database.list"
]
}[
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"allOf": [
{
"properties": {
"caching": {
"properties": {
"disabled": {
"description": "When set to true, disables the caching of SQL responses. (Default: false)",
"example": false,
"type": "boolean"
},
"max_age": {
"description": "When present, specifies max duration for which items should persist in the cache. (Default: 60)",
"example": 30,
"type": "integer"
},
"stale_while_revalidate": {
"description": "When present, indicates the number of seconds cache may serve the response after it becomes stale. (Default: 15)",
"example": 15,
"type": "integer"
}
},
"type": "object"
},
"name": {
"example": "example-hyperdrive",
"type": "string"
},
"origin": {
"allOf": [
{
"properties": {
"database": {
"description": "The name of your origin database.",
"example": "postgres",
"type": "string"
},
"host": {
"description": "The host (hostname or IP) of your origin database.",
"example": "database.example.com",
"type": "string"
},
"port": {
"description": "The port (default: 5432 for Postgres) of your origin database.",
"example": "5432",
"type": "integer"
},
"scheme": {
"default": "postgres",
"description": "Specifies the URL scheme used to connect to your origin database.",
"enum": [
"postgres",
"postgresql"
],
"type": "string"
},
"user": {
"description": "The user of your origin database.",
"example": "postgres",
"type": "string"
}
},
"type": "object"
},
{
"required": [
"host",
"port"
]
}
]
}
},
"required": [
"name",
"origin"
],
"type": "object"
}
],
"properties": {
"id": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
}
]
}
}
},
"description": "List Hyperdrives Response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
],
"nullable": true,
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"nullable": true,
"type": "object"
}
},
"type": "object"
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "List Hyperdrives Failure Response"
}
}[
{
"api_token": []
},
{
"api_email": [],
"api_key": []
}
]