API reference

Databases

Managed PostgreSQL, MySQL, MariaDB and Redis: creating one, reading and writing its rows, running SQL, and its backups and restores.

Databases of a workspace, newest first

GET/v1/orgs/{org}/databases

API token or dashboard session

Databases of a workspace, newest first.

Path parameters

orgstringpathrequired
Organisation slug

Responses

200Database[]

Fields of Database

allowstring[]required
Networks that may connect from outside, as addresses or CIDR ranges. Empty: any may, with the password.
backup_everystringrequired
off, hourly, daily or weekly.
backup_keepintegerrequired
Scheduled backups kept.
created_atdate-timerequired
databasestringrequired
editorbooleanrequired
Whether the dashboard can browse and edit its content.
engineEnginerequired
environmentstringrequired
hoststringrequired
How services of its environment reach it.
iduuidrequired
namestringrequired
Its name: also its hostname for the services of its environment.
portintegerrequired
projectstringrequired
The project and environment whose services reach it by name.
publicbooleanrequired
Whether it can be reached from the internet.
public_addressstring | null
Where, when it can: host:port. Present once it has been opened, and kept if it is closed and opened again.
referencestringrequired
The variable of this database to refer to from another service: ${{name.DATABASE_URL}}.
standalonebooleanrequired
Created from the Databases page rather than inside a project.
statusstring | null
queued, building, live or failed: the state of the service that runs it.
userstringrequired
versionstringrequired

curl "https://api.infraflow.app/v1/orgs/acme/databases" \
  -H "Authorization: Bearer $INFRAFLOW_TOKEN"

Response · 200

[
  {
    "allow": [
      "string"
    ],
    "backup_every": "string",
    "backup_keep": 0,
    "created_at": "2026-01-15T09:30:00Z",
    "database": "string",
    "editor": true,
    "engine": "postgres",
    "environment": "string",
    "host": "string",
    "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55",
    "name": "my-app",
    "port": 3000,
    "project": "storefront",
    "public": true,
    "public_address": "string",
    "reference": "string",
    "standalone": true,
    "status": "string",
    "user": "string",
    "version": "string"
  }
]

Create a database

POST/v1/orgs/{org}/databases

API token or dashboard session

Create a database. It starts at once, with a generated password, on a disk of its own that survives restarts and new versions.

Path parameters

orgstringpathrequired
Organisation slug

Request body · application/json

allowstring[]
Networks that may connect from outside. Any, if absent or empty.
engineEnginerequired
environmentstring | null
Slug of the environment. production if absent.
memory_mb

One database

GET/v1/orgs/{org}/databases/{database}

API token or dashboard session

One database.

Path parameters

orgstringpathrequired
Organisation slug
databasestringpathrequired

Responses

200Database
404Problem

Fields of Database

allowstring[]required
Networks that may connect from outside, as addresses or CIDR ranges. Empty: any may, with the password.

Change how a database is backed up

PATCH/v1/orgs/{org}/databases/{database}

API token or dashboard session

Change how a database is backed up.

Path parameters

orgstringpathrequired
Organisation slug
databasestringpathrequired

Request body · application/json

allowstring[] | null
Networks that may connect from outside. Empty: any may.
backup_everystring | null
off, hourly, daily or weekly.

Delete a database: its content and its backups are gone for good

DELETE/v1/orgs/{org}/databases/{database}

API token or dashboard session

Delete a database: its content and its backups are gone for good.

Path parameters

orgstringpathrequired
Organisation slug
databasestringpathrequired

Responses

204no body
404Problem

curl -X DELETE "https://api.infraflow.app/v1/orgs/acme/databases/database" \
  -H "Authorization: Bearer $INFRAFLOW_TOKEN"

A database's backups, newest first, and its latest restores

GET/v1/orgs/{org}/databases/{database}/backups

API token or dashboard session

A database's backups, newest first, and its latest restores.

Path parameters

orgstringpathrequired
Organisation slug
databasestringpathrequired

Responses

200Backups

Fields of Backups

backupsBackup[]required
- created_atdate-timerequired

Back a database up now

POST/v1/orgs/{org}/databases/{database}/backups

API token or dashboard session

Back a database up now. The node that runs it makes the dump; follow its status in the list.

Path parameters

orgstringpathrequired
Organisation slug
databasestringpathrequired

Responses

201Backup
409Problem
backup_in_progress, not_running

Fields of Backup

Delete a backup and its file

DELETE/v1/orgs/{org}/databases/{database}/backups/{id}

API token or dashboard session

Delete a backup and its file.

Path parameters

orgstringpathrequired
Organisation slug
databasestringpathrequired
iduuidpathrequired

Responses

204no body
404Problem

curl -X DELETE "https://api.infraflow.app/v1/orgs/acme/databases/database/backups/0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55" \
  -H "Authorization: Bearer $INFRAFLOW_TOKEN"

Download a backup: a gzip-compressed SQL dump

GET/v1/orgs/{org}/databases/{database}/backups/{id}/download

API token or dashboard session

Download a backup: a gzip-compressed SQL dump.

Path parameters

orgstringpathrequired
Organisation slug
databasestringpathrequired
iduuidpathrequired

Responses

200no body
The dump, as application/gzip
404Problem

curl "https://api.infraflow.app/v1/orgs/acme/databases/database/backups/0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55/download" \
  -H "Authorization: Bearer $INFRAFLOW_TOKEN"

Put a backup back: the database's content becomes what it was then

POST/v1/orgs/{org}/databases/{database}/backups/{id}/restore

API token or dashboard session

Put a backup back: the database's content becomes what it was then. What was written since is lost.

Path parameters

orgstringpathrequired
Organisation slug
databasestringpathrequired
iduuidpathrequired

Responses

201Restore
409Problem
not_ready, not_running

How to connect, password included

GET/v1/orgs/{org}/databases/{database}/connection

API token or dashboard session

How to connect, password included. From the dashboard this needs a recent confirmation of identity.

Path parameters

orgstringpathrequired
Organisation slug
databasestringpathrequired

Responses

200Connection
403Problem
confirmation_required

Fields of Connection

databasestringrequired

Empty a database: every table, view, function and row is removed

POST/v1/orgs/{org}/databases/{database}/empty

API token or dashboard session

Empty a database: every table, view, function and row is removed. The database itself stays, with its address, its password and its backups.

Path parameters

orgstringpathrequired
Organisation slug
databasestringpathrequired

Request body · application/json

confirmstringrequired
The database's name, typed again: this cannot be undone.

Responses

204no body

Run SQL as the database's administrator and return what it gives: the first 1,000 rows of its last statement

POST/v1/orgs/{org}/databases/{database}/query

API token or dashboard session

Run SQL as the database's administrator and return what it gives: the first 1,000 rows of its last statement. Stopped after fifteen seconds.

Path parameters

orgstringpathrequired
Organisation slug
databasestringpathrequired

Request body · application/json

sqlstringrequired

Responses

200QueryOutcome
400Problem

A page of a table's rows, with its columns

GET/v1/orgs/{org}/databases/{database}/rows

API token or dashboard session

A page of a table's rows, with its columns.

Path and query parameters

orgstringpathrequired
Organisation slug
databasestringpathrequired
schemastringqueryrequired
tablestringqueryrequired
limitintegerquery
Rows to return, 100 by default, 1000 at most.

Insert, change or delete one row of a table

POST/v1/orgs/{org}/databases/{database}/rows

API token or dashboard session

Insert, change or delete one row of a table.

Path parameters

orgstringpathrequired
Organisation slug
databasestringpathrequired

Request body · application/json

actionRowActionrequired
keymap of string
The row to change or delete: its primary key columns and their values.
schemastringrequired

The tables and views of a database

GET/v1/orgs/{org}/databases/{database}/tables

API token or dashboard session

The tables and views of a database.

Path parameters

orgstringpathrequired
Organisation slug
databasestringpathrequired

Responses

200Table[]
409Problem
not_running, not_reachable

Fields of Table

bytesintegerrequired

[ { "allow": [ "string" ], "backup_every": "string", "backup_keep": 0, "created_at": "2026-01-15T09:30:00Z", "database": "string", "editor": true, "engine": "postgres", "environment": "string", "host": "string", "id": "0197b2a4-5c1e-7d3a-9f10-4b6c8e2a1d55", "name": "my-app", "port": 3000, "project": "storefront", "public": true, "public_address": "string", "reference": "string", "standalone": true, "status": "string", "user": "string", "version": "string" } ]