API reference
databases
10 endpoints in this area. Each one has its own page with its parameters, its response and a request you can run.
| Method | Path | What it does | Permission |
|---|---|---|---|
| GET | /v1/databases | The organisation's managed databases. | databases.view |
| POST | /v1/databases | Validate a managed database, and say where to buy it. | databases.manage |
| GET | /v1/databases/catalogue | The managed-database sizes and engine versions on sale. | databases.view |
| DELETE | /v1/databases/{databaseId} | Delete a managed database and its backups. | databases.manage |
| GET | /v1/databases/{databaseId} | One managed database. | databases.view |
| GET | /v1/databases/{databaseId}/allowed-ips | Which sources may connect to this database. | databases.view |
| POST | /v1/databases/{databaseId}/allowed-ips | Permit a source address or range to connect. | databases.manage |
| DELETE | /v1/databases/{databaseId}/allowed-ips/{ruleId} | Revoke a source's access. | databases.manage |
| POST | /v1/databases/{databaseId}/credentials | Reveal the database password. | databases.credentials.reveal |
| POST | /v1/databases/{databaseId}/upgrade | Move the database to a newer PostgreSQL major. | databases.manage |