Pause project with the Supabase API
Pauses a project, which takes its database, APIs and functions offline until Restore project. Only projects of free plan organizations can be paused. Paused projects do not count toward the limit of two free projects.
- Identifier
- supabase_pause_project
The request
POST https://connect.reportei.com/api/tools/supabase_pause_project/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"ref": "<ref>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| ref | string | Yes | Ref of the project, from List projects. |
Supported connections
Your customer connects their Supabase account once, with one of the modes below. The same connection serves every tool of the toolkit.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/supabase_pause_project. It becomes your agent's tool definition with no conversion.
Other Supabase tools
- List organizationsGETLists the organizations the token reaches, each with id, slug and name. The slug is what the organization tools ask for.
- Get organizationGETReturns one organization with its name and plan: free, pro, team, enterprise or platform.
- List organization membersGETLists the members of an organization, each with user name, email, role and whether MFA is on.
- List projectsGETLists the projects of an organization, each with its ref, name, region and status. The ref is what the project tools ask for. Page with limit and offset; pagination.count is the total.
- Get projectGETReturns one project with its name, organization, region, creation date, status and database host and version.
- Update projectPATCHRenames a project. The name is the only field this call changes.
- Restore projectPOSTBrings a paused project back with its data and settings. A project can be restored for up to a year after it was paused, and on a free plan it counts again toward the limit of two active free projects.
- Get project healthGETReturns the health of the services of a project, each with healthy, status and the error when there is one.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
