Skip to content
Install

Create a Postgres database in a project

POST
/projects/{id}/databases
curl --request POST \
--url https://example.com/projects/example/databases \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "cpuRequestMilli": 1, "memoryRequestBytes": 1, "name": "example", "restoreFromUrl": "example", "storageSize": "example", "templateInstanceId": "example" }'

Auth: authenticated (scope: deploy)

id
required
string
Media typeapplication/json
object
cpuRequestMilli
integer | null
> 0
memoryRequestBytes
integer | null
> 0
name
required
string
restoreFromUrl

Optional postgres:// URL to migrate data from on first boot.

string
storageSize

Storage size as a Kubernetes quantity, e.g. “1Gi”. Defaults to “1Gi”.

string
/^\d+(Mi|Gi|Ti)$/
templateInstanceId
string

Example generated

{
"cpuRequestMilli": 1,
"memoryRequestBytes": 1,
"name": "example",
"restoreFromUrl": "example",
"storageSize": "example",
"templateInstanceId": "example"
}

OK

Media typeapplication/json
object
backupScheduleCron
string | null
clusterName
string | null
containerName
string | null
cpuRequestMilli
number | null
createdAt
required
string
createdBy
string | null
creator
object
email
string | null
firstName
string | null
id
required
string
lastName
string | null
username
string | null
key
additional properties
dbName
required
string
dbPassword
required
string | null
dbUser
required
string
environmentId
string | null
host
required
string
id
required
string
importBoosted
required
boolean
installedExtensions
liveStatus
object
conditions
Array<object>
object
key
additional properties
connections
number
currentPrimary
string
exists
boolean
lastTerminationAt
string
lastTerminationExitCode
number
lastTerminationReason
string
message
string
phase
string
ready
boolean
readyReplicas
number
replicas
number
restartCount
number
size
string
key
additional properties
memoryRequestBytes
Any of:
string
mode
required
string
name
required
string
namespace
string | null
pgParameters
object | null
port
required
number
projectId
required
string
publicEnabled
required
boolean
publicIp
string | null
publicPort
number | null
r2ProxyAccessKey
string | null
r2ProxySecret
string | null
sharedPreloadLibs
Array<string> | null
status
required
string
storageSize
string | null
templateInstanceId
string | null
updatedAt
required
string
key
additional properties

Example generated

{
"backupScheduleCron": "example",
"clusterName": "example",
"containerName": "example",
"cpuRequestMilli": 1,
"createdAt": "example",
"createdBy": "example",
"creator": {
"email": "example",
"firstName": "example",
"id": "example",
"lastName": "example",
"username": "example"
},
"dbName": "example",
"dbPassword": "example",
"dbUser": "example",
"environmentId": "example",
"host": "example",
"id": "example",
"importBoosted": true,
"installedExtensions": "example",
"liveStatus": {
"conditions": [
{
"additionalProperty": "example"
}
],
"connections": 1,
"currentPrimary": "example",
"exists": true,
"lastTerminationAt": "example",
"lastTerminationExitCode": 1,
"lastTerminationReason": "example",
"message": "example",
"phase": "example",
"ready": true,
"readyReplicas": 1,
"replicas": 1,
"restartCount": 1,
"size": "example"
},
"memoryRequestBytes": "example",
"mode": "example",
"name": "example",
"namespace": "example",
"pgParameters": "example",
"port": 1,
"projectId": "example",
"publicEnabled": true,
"publicIp": "example",
"publicPort": 1,
"r2ProxyAccessKey": "example",
"r2ProxySecret": "example",
"sharedPreloadLibs": [
"example"
],
"status": "example",
"storageSize": "example",
"templateInstanceId": "example",
"updatedAt": "example"
}