# Prisma Postgres Management API

REST API for managing Prisma Postgres projects, databases, backups, and workspaces.

Version `v1`

Servers: `https://api.prisma.io`

## Operations

| Method | Path | Operation |
| --- | --- | --- |
| `GET` | `/v1/agent-approvals/{approvalId}` | [Poll an approval](./api/operations/getv1agent-approvalsbyapprovalid.md) |
| `GET` | `/v1/apps` | [List apps](./api/operations/getv1apps.md) |
| `POST` | `/v1/apps` | [Create app](./api/operations/postv1apps.md) |
| `DELETE` | `/v1/apps/{appId}` | [Delete app](./api/operations/deletev1appsbyappid.md) |
| `GET` | `/v1/apps/{appId}` | [Get app](./api/operations/getv1appsbyappid.md) |
| `PATCH` | `/v1/apps/{appId}` | [Update app](./api/operations/patchv1appsbyappid.md) |
| `GET` | `/v1/apps/{appId}/deployments` | [List deployments](./api/operations/getv1appsbyappiddeployments.md) |
| `POST` | `/v1/apps/{appId}/deployments` | [Create deployment](./api/operations/postv1appsbyappiddeployments.md) |
| `GET` | `/v1/apps/{appId}/domains` | [List custom domains for an app](./api/operations/getv1appsbyappiddomains.md) |
| `POST` | `/v1/apps/{appId}/domains` | [Create a custom domain](./api/operations/postv1appsbyappiddomains.md) |
| `POST` | `/v1/apps/{appId}/promote` | [Promote deployment](./api/operations/postv1appsbyappidpromote.md) |
| `POST` | `/v1/apps/{appId}/rollback` | [Roll an app back to an existing deployment](./api/operations/postv1appsbyappidrollback.md) |
| `POST` | `/v1/auth/github-actions/token` | [Exchange a GitHub Actions OIDC token for a workspace service token](./api/operations/postv1authgithub-actionstoken.md) |
| `DELETE` | `/v1/branches/{branchId}` | [Soft-delete a branch](./api/operations/deletev1branchesbybranchid.md) |
| `GET` | `/v1/branches/{branchId}` | [Get a branch](./api/operations/getv1branchesbybranchid.md) |
| `PATCH` | `/v1/branches/{branchId}` | [Update a branch](./api/operations/patchv1branchesbybranchid.md) |
| `GET` | `/v1/buckets` | [List buckets](./api/operations/getv1buckets.md) |
| `POST` | `/v1/buckets` | [Create bucket](./api/operations/postv1buckets.md) |
| `DELETE` | `/v1/buckets/{bucketId}` | [Delete bucket](./api/operations/deletev1bucketsbybucketid.md) |
| `GET` | `/v1/buckets/{bucketId}` | [Get bucket](./api/operations/getv1bucketsbybucketid.md) |
| `PATCH` | `/v1/buckets/{bucketId}` | [Update bucket](./api/operations/patchv1bucketsbybucketid.md) |
| `GET` | `/v1/buckets/{bucketId}/keys` | [List bucket keys](./api/operations/getv1bucketsbybucketidkeys.md) |
| `POST` | `/v1/buckets/{bucketId}/keys` | [Create bucket key](./api/operations/postv1bucketsbybucketidkeys.md) |
| `DELETE` | `/v1/buckets/{bucketId}/keys/{keyId}` | [Delete bucket key](./api/operations/deletev1bucketsbybucketidkeysbykeyid.md) |
| `GET` | `/v1/builds` | [List builds](./api/operations/getv1builds.md) |
| `POST` | `/v1/builds` | [Report a build](./api/operations/postv1builds.md) |
| `GET` | `/v1/builds/{buildId}` | [Get a build](./api/operations/getv1buildsbybuildid.md) |
| `PATCH` | `/v1/builds/{buildId}` | [Update a build](./api/operations/patchv1buildsbybuildid.md) |
| `GET` | `/v1/builds/{buildId}/logs` | [Stream build logs](./api/operations/getv1buildsbybuildidlogs.md) |
| `PUT` | `/v1/builds/{buildId}/resources/{resourceType}/{resourceId}` | [Report a resource a build acted on](./api/operations/putv1buildsbybuildidresourcesbyresourcetypebyresourceid.md) |
| `GET` | `/v1/connections` | [List connections](./api/operations/getv1connections.md) |
| `POST` | `/v1/connections` | [Create connection](./api/operations/postv1connections.md) |
| `DELETE` | `/v1/connections/{id}` | [Delete connection](./api/operations/deletev1connectionsbyid.md) |
| `GET` | `/v1/connections/{id}` | [Get connection](./api/operations/getv1connectionsbyid.md) |
| `POST` | `/v1/connections/{id}/rotate` | [Rotate connection credentials](./api/operations/postv1connectionsbyidrotate.md) |
| `GET` | `/v1/databases` | [List databases](./api/operations/getv1databases.md) |
| `POST` | `/v1/databases` | [Create database](./api/operations/postv1databases.md) |
| `DELETE` | `/v1/databases/{databaseId}` | [Delete database](./api/operations/deletev1databasesbydatabaseid.md) |
| `GET` | `/v1/databases/{databaseId}` | [Get database](./api/operations/getv1databasesbydatabaseid.md) |
| `PATCH` | `/v1/databases/{databaseId}` | [Update database](./api/operations/patchv1databasesbydatabaseid.md) |
| `GET` | `/v1/databases/{databaseId}/backups` | [Get list of backups](./api/operations/getv1databasesbydatabaseidbackups.md) |
| `GET` | `/v1/databases/{databaseId}/connections` | [Get list of database connections](./api/operations/getv1databasesbydatabaseidconnections.md) |
| `POST` | `/v1/databases/{databaseId}/connections` | [Create database connection string](./api/operations/postv1databasesbydatabaseidconnections.md) |
| `GET` | `/v1/databases/{databaseId}/usage` | [Get database usage metrics](./api/operations/getv1databasesbydatabaseidusage.md) |
| `POST` | `/v1/databases/{targetDatabaseId}/restore` | [Restore database (destructive)](./api/operations/postv1databasesbytargetdatabaseidrestore.md) |
| `DELETE` | `/v1/deployments/{deploymentId}` | [Delete deployment](./api/operations/deletev1deploymentsbydeploymentid.md) |
| `GET` | `/v1/deployments/{deploymentId}` | [Get deployment](./api/operations/getv1deploymentsbydeploymentid.md) |
| `GET` | `/v1/deployments/{deploymentId}/logs` | [Get deployment logs](./api/operations/getv1deploymentsbydeploymentidlogs.md) |
| `POST` | `/v1/deployments/{deploymentId}/start` | [Start deployment](./api/operations/postv1deploymentsbydeploymentidstart.md) |
| `POST` | `/v1/deployments/{deploymentId}/stop` | [Stop deployment](./api/operations/postv1deploymentsbydeploymentidstop.md) |
| `DELETE` | `/v1/domains/{domainId}` | [Delete a custom domain](./api/operations/deletev1domainsbydomainid.md) |
| `GET` | `/v1/domains/{domainId}` | [Get a custom domain](./api/operations/getv1domainsbydomainid.md) |
| `POST` | `/v1/domains/{domainId}/retry` | [Retry custom domain provisioning](./api/operations/postv1domainsbydomainidretry.md) |
| `GET` | `/v1/environment-variables` | [List environment variables](./api/operations/getv1environment-variables.md) |
| `POST` | `/v1/environment-variables` | [Create an environment variable](./api/operations/postv1environment-variables.md) |
| `DELETE` | `/v1/environment-variables/{envVarId}` | [Delete an environment variable](./api/operations/deletev1environment-variablesbyenvvarid.md) |
| `GET` | `/v1/environment-variables/{envVarId}` | [Get an environment variable](./api/operations/getv1environment-variablesbyenvvarid.md) |
| `PATCH` | `/v1/environment-variables/{envVarId}` | [Update an environment variable's value](./api/operations/patchv1environment-variablesbyenvvarid.md) |
| `GET` | `/v1/integrations` | [Get list of integrations](./api/operations/getv1integrations.md) |
| `DELETE` | `/v1/integrations/{id}` | [Delete integration](./api/operations/deletev1integrationsbyid.md) |
| `GET` | `/v1/integrations/{id}` | [Get integration by ID](./api/operations/getv1integrationsbyid.md) |
| `GET` | `/v1/me` | [Get current authenticated principal](./api/operations/getv1me.md) |
| `GET` | `/v1/projects` | [Get list of projects](./api/operations/getv1projects.md) |
| `POST` | `/v1/projects` | [Create project with a postgres database](./api/operations/postv1projects.md) |
| `DELETE` | `/v1/projects/{id}` | [Delete project](./api/operations/deletev1projectsbyid.md) |
| `GET` | `/v1/projects/{id}` | [Get project](./api/operations/getv1projectsbyid.md) |
| `PATCH` | `/v1/projects/{id}` | [Update project](./api/operations/patchv1projectsbyid.md) |
| `POST` | `/v1/projects/{id}/transfer` | [Transfer project](./api/operations/postv1projectsbyidtransfer.md) |
| `GET` | `/v1/projects/{projectId}/branches` | [List branches in a project](./api/operations/getv1projectsbyprojectidbranches.md) |
| `POST` | `/v1/projects/{projectId}/branches` | [Create a branch](./api/operations/postv1projectsbyprojectidbranches.md) |
| `DELETE` | `/v1/projects/{projectId}/branches/{branchId}/alchemy-state/lease` | [Release Alchemy deploy lease](./api/operations/deletev1projectsbyprojectidbranchesbybranchidalchemy-statelease.md) |
| `PATCH` | `/v1/projects/{projectId}/branches/{branchId}/alchemy-state/lease` | [Heartbeat Alchemy deploy lease](./api/operations/patchv1projectsbyprojectidbranchesbybranchidalchemy-statelease.md) |
| `POST` | `/v1/projects/{projectId}/branches/{branchId}/alchemy-state/lease` | [Acquire Alchemy deploy lease](./api/operations/postv1projectsbyprojectidbranchesbybranchidalchemy-statelease.md) |
| `GET` | `/v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks` | [List Alchemy stacks](./api/operations/getv1projectsbyprojectidbranchesbybranchidalchemy-statestatestacks.md) |
| `DELETE` | `/v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}` | [Delete Alchemy stack state](./api/operations/deletev1projectsbyprojectidbranchesbybranchidalchemy-statestatestacksbystack.md) |
| `GET` | `/v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}/stages` | [List Alchemy stages](./api/operations/getv1projectsbyprojectidbranchesbybranchidalchemy-statestatestacksbystackstages.md) |
| `GET` | `/v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}/stages/{stage}/output` | [Get Alchemy stack output](./api/operations/getv1projectsbyprojectidbranchesbybranchidalchemy-statestatestacksbystackstagesbystageoutput.md) |
| `PUT` | `/v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}/stages/{stage}/output` | [Set Alchemy stack output](./api/operations/putv1projectsbyprojectidbranchesbybranchidalchemy-statestatestacksbystackstagesbystageoutput.md) |
| `GET` | `/v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}/stages/{stage}/replaced-resources` | [List replaced Alchemy resources](./api/operations/getv1projectsbyprojectidbranchesbybranchidalchemy-statestatestacksbystackstagesbystagereplaced-resources.md) |
| `GET` | `/v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}/stages/{stage}/resources` | [List Alchemy resources](./api/operations/getv1projectsbyprojectidbranchesbybranchidalchemy-statestatestacksbystackstagesbystageresources.md) |
| `DELETE` | `/v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}/stages/{stage}/resources/{fqn}` | [Delete Alchemy resource state](./api/operations/deletev1projectsbyprojectidbranchesbybranchidalchemy-statestatestacksbystackstagesbystageresourcesbyfqn.md) |
| `GET` | `/v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}/stages/{stage}/resources/{fqn}` | [Get Alchemy resource state](./api/operations/getv1projectsbyprojectidbranchesbybranchidalchemy-statestatestacksbystackstagesbystageresourcesbyfqn.md) |
| `PUT` | `/v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}/stages/{stage}/resources/{fqn}` | [Set Alchemy resource state](./api/operations/putv1projectsbyprojectidbranchesbybranchidalchemy-statestatestacksbystackstagesbystageresourcesbyfqn.md) |
| `GET` | `/v1/projects/{projectId}/branches/{branchId}/alchemy-state/version` | [Alchemy state store version](./api/operations/getv1projectsbyprojectidbranchesbybranchidalchemy-stateversion.md) |
| `GET` | `/v1/projects/{projectId}/branches/{branchId}/application-topology` | [Get branch topology](./api/operations/getv1projectsbyprojectidbranchesbybranchidapplication-topology.md) |
| `PUT` | `/v1/projects/{projectId}/branches/{branchId}/application-topology` | [Replace branch topology](./api/operations/putv1projectsbyprojectidbranchesbybranchidapplication-topology.md) |
| `GET` | `/v1/projects/{projectId}/databases` | [Get list of databases](./api/operations/getv1projectsbyprojectiddatabases.md) |
| `POST` | `/v1/projects/{projectId}/databases` | [Create database](./api/operations/postv1projectsbyprojectiddatabases.md) |
| `GET` | `/v1/regions` | [Get all regions](./api/operations/getv1regions.md) |
| `GET` | `/v1/regions/accelerate` | [Get Prisma Accelerate regions](./api/operations/getv1regionsaccelerate.md) |
| `GET` | `/v1/regions/postgres` | [Get Prisma Postgres regions](./api/operations/getv1regionspostgres.md) |
| `GET` | `/v1/scm-installations` | [List SCM installations for a workspace](./api/operations/getv1scm-installations.md) |
| `POST` | `/v1/scm-installations/install-intents` | [Create an SCM App installation intent](./api/operations/postv1scm-installationsinstall-intents.md) |
| `GET` | `/v1/scm-installations/{installationId}/repositories` | [List repositories accessible to an SCM installation](./api/operations/getv1scm-installationsbyinstallationidrepositories.md) |
| `GET` | `/v1/services` | [List services](./api/operations/getv1services.md) |
| `POST` | `/v1/services` | [Create service](./api/operations/postv1services.md) |
| `DELETE` | `/v1/services/{serviceId}` | [Delete service](./api/operations/deletev1servicesbyserviceid.md) |
| `GET` | `/v1/services/{serviceId}` | [Get service](./api/operations/getv1servicesbyserviceid.md) |
| `PATCH` | `/v1/services/{serviceId}` | [Update service](./api/operations/patchv1servicesbyserviceid.md) |
| `GET` | `/v1/services/{serviceId}/deployments` | [List deployments](./api/operations/getv1servicesbyserviceiddeployments.md) |
| `POST` | `/v1/services/{serviceId}/deployments` | [Create deployment](./api/operations/postv1servicesbyserviceiddeployments.md) |
| `GET` | `/v1/services/{serviceId}/domains` | [List custom domains for a service](./api/operations/getv1servicesbyserviceiddomains.md) |
| `POST` | `/v1/services/{serviceId}/domains` | [Create a custom domain](./api/operations/postv1servicesbyserviceiddomains.md) |
| `POST` | `/v1/services/{serviceId}/promote` | [Promote deployment](./api/operations/postv1servicesbyserviceidpromote.md) |
| `POST` | `/v1/services/{serviceId}/rollback` | [Roll a service back to an existing deployment](./api/operations/postv1servicesbyserviceidrollback.md) |
| `GET` | `/v1/source-repositories` | [List source repositories](./api/operations/getv1source-repositories.md) |
| `POST` | `/v1/source-repositories` | [Link a source repository to a project](./api/operations/postv1source-repositories.md) |
| `DELETE` | `/v1/source-repositories/{id}` | [Disconnect a source repository](./api/operations/deletev1source-repositoriesbyid.md) |
| `GET` | `/v1/source-repositories/{id}` | [Get a source repository](./api/operations/getv1source-repositoriesbyid.md) |
| `GET` | `/v1/workspaces` | [Get list of workspaces](./api/operations/getv1workspaces.md) |
| `POST` | `/v1/workspaces` | [Create a workspace](./api/operations/postv1workspaces.md) |
| `GET` | `/v1/workspaces/{id}` | [Get workspace](./api/operations/getv1workspacesbyid.md) |
| `GET` | `/v1/workspaces/{id}/subscription` | [Get workspace subscription](./api/operations/getv1workspacesbyidsubscription.md) |
| `GET` | `/v1/workspaces/{workspaceId}/integrations` | [Get list of integrations](./api/operations/getv1workspacesbyworkspaceidintegrations.md) |
| `DELETE` | `/v1/workspaces/{workspaceId}/integrations/{clientId}` | [Revoke integration tokens](./api/operations/deletev1workspacesbyworkspaceidintegrationsbyclientid.md) |
| `GET` | `/v1/workspaces/{workspaceId}/service-tokens` | [List service tokens](./api/operations/getv1workspacesbyworkspaceidservice-tokens.md) |
| `POST` | `/v1/workspaces/{workspaceId}/service-tokens` | [Create service token](./api/operations/postv1workspacesbyworkspaceidservice-tokens.md) |
| `DELETE` | `/v1/workspaces/{workspaceId}/service-tokens/{serviceTokenId}` | [Delete service token](./api/operations/deletev1workspacesbyworkspaceidservice-tokensbyservicetokenid.md) |

## Related pages

- [[Experimental]](./api/operations/tags/experimental.md)
- [Acquire Alchemy deploy lease](./api/operations/postv1projectsbyprojectidbranchesbybranchidalchemy-statelease.md)
- [Agents](./api/operations/tags/agents.md)
- [Alchemy state store version](./api/operations/getv1projectsbyprojectidbranchesbybranchidalchemy-stateversion.md)
- [Buckets](./api/operations/tags/buckets.md)
- [Connections](./api/operations/tags/connections.md)
- [Create a branch](./api/operations/postv1projectsbyprojectidbranches.md)
- [Create a custom domain](./api/operations/postv1appsbyappiddomains.md)
- [Create a custom domain](./api/operations/postv1servicesbyserviceiddomains.md)
- [Create a workspace](./api/operations/postv1workspaces.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.