Skip to main content
POST
Stop Database
string
required
The API key for your account. You can find this in your account settings.
Stops a running database container. The data volume is preserved, so a subsequent Start Database call brings it back with the same credentials, port and connection URL. Use this to pause billing-relevant usage or take a database offline before maintenance. The request is rejected while a snapshot restore is in progress on the same database. Rate limited to 1 stop per 3 seconds per user. To check whether the stop actually took effect, poll Get Database Status.

Parameters

string
required
The ID of the database.

Response

string
Indicates whether the call was successful.. success if successful, error if not.

Common errors