Stop database
Stop a running database with POST /v2/databases/:database_id/stop. Its data is kept, and it starts again with the same credentials and connection URL.
POST
Stop database
The API key for your account. You can find this in your account settings.
databases:write scope.
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
Response
Common errors
Related
- CLI:
squarecloud db stop - SDKs:
api.databases.stop()(JavaScript),client.databases.stop()(Python),c.Databases.Stop()(Go)

