Skip to main content
Prisma Documentation Docs

Search documentation

Type to search this documentation.

On this pageOverview

Prisma Postgres Management API

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

Version
v1
Base URL
https://api.prisma.io

Projects6 operations

GETGet list of projects/v1/projectsPOSTCreate project with a postgres database/v1/projectsDELETEDelete project/v1/projects/{id}GETGet project/v1/projects/{id}PATCHUpdate project/v1/projects/{id}POSTTransfer project/v1/projects/{id}/transfer

Databases8 operations

GETList databases/v1/databasesPOSTCreate database/v1/databasesDELETEDelete database/v1/databases/{databaseId}GETGet database/v1/databases/{databaseId}PATCHUpdate database/v1/databases/{databaseId}POSTRestore database (destructive)/v1/databases/{targetDatabaseId}/restoreGETGet list of databases/v1/projects/{projectId}/databasesPOSTCreate database/v1/projects/{projectId}/databases

Databases Connections2 operations

GETGet list of database connections/v1/databases/{databaseId}/connectionsPOSTCreate database connection string/v1/databases/{databaseId}/connections

Database Backups1 operation

GETGet list of backups/v1/databases/{databaseId}/backups

Database Usage1 operation

GETGet database usage metrics/v1/databases/{databaseId}/usage

Connections5 operations

GETList connections/v1/connectionsPOSTCreate connection/v1/connectionsDELETEDelete connection/v1/connections/{id}GETGet connection/v1/connections/{id}POSTRotate connection credentials/v1/connections/{id}/rotate

Integrations5 operations

GETGet list of integrations/v1/integrationsDELETEDelete integration/v1/integrations/{id}GETGet integration by ID/v1/integrations/{id}GETGet list of integrations/v1/workspaces/{workspaceId}/integrationsDELETERevoke integration tokens/v1/workspaces/{workspaceId}/integrations/{clientId}

Service Tokens3 operations

GETList service tokens/v1/workspaces/{workspaceId}/service-tokensPOSTCreate service token/v1/workspaces/{workspaceId}/service-tokensDELETEDelete service token/v1/workspaces/{workspaceId}/service-tokens/{serviceTokenId}

Workspaces3 operations

GETGet list of workspaces/v1/workspacesGETGet workspace/v1/workspaces/{id}GETGet workspace subscription/v1/workspaces/{id}/subscription

Regions1 operation

GETGet all regions/v1/regions

Misc3 operations

GETGet current authenticated principal/v1/meGETGet Prisma Accelerate regions/v1/regions/accelerateGETGet Prisma Postgres regions/v1/regions/postgres

[Experimental]71 operations

Experimental endpoints are in active development and may change at any time without notice.

GETList apps/v1/appsPOSTCreate app/v1/appsDELETEDelete app/v1/apps/{appId}GETGet app/v1/apps/{appId}PATCHUpdate app/v1/apps/{appId}GETList deployments/v1/apps/{appId}/deploymentsPOSTCreate deployment/v1/apps/{appId}/deploymentsGETList custom domains for an app/v1/apps/{appId}/domainsPOSTCreate a custom domain/v1/apps/{appId}/domainsPOSTPromote deployment/v1/apps/{appId}/promotePOSTRoll an app back to an existing deployment/v1/apps/{appId}/rollbackPOSTExchange a GitHub Actions OIDC token for a workspace service token/v1/auth/github-actions/tokenDELETESoft-delete a branch/v1/branches/{branchId}GETGet a branch/v1/branches/{branchId}PATCHUpdate a branch/v1/branches/{branchId}GETList builds/v1/buildsPOSTReport a build/v1/buildsGETGet a build/v1/builds/{buildId}PATCHUpdate a build/v1/builds/{buildId}GETStream build logs/v1/builds/{buildId}/logsPUTReport a resource a build acted on/v1/builds/{buildId}/resources/{resourceType}/{resourceId}DELETEDelete deployment/v1/deployments/{deploymentId}GETGet deployment/v1/deployments/{deploymentId}GETGet deployment logs/v1/deployments/{deploymentId}/logsPOSTStart deployment/v1/deployments/{deploymentId}/startPOSTStop deployment/v1/deployments/{deploymentId}/stopDELETEDelete a custom domain/v1/domains/{domainId}GETGet a custom domain/v1/domains/{domainId}POSTRetry custom domain provisioning/v1/domains/{domainId}/retryGETList environment variables/v1/environment-variablesPOSTCreate an environment variable/v1/environment-variablesDELETEDelete an environment variable/v1/environment-variables/{envVarId}GETGet an environment variable/v1/environment-variables/{envVarId}PATCHUpdate an environment variable's value/v1/environment-variables/{envVarId}GETList branches in a project/v1/projects/{projectId}/branchesPOSTCreate a branch/v1/projects/{projectId}/branchesDELETERelease Alchemy deploy lease/v1/projects/{projectId}/branches/{branchId}/alchemy-state/leasePATCHHeartbeat Alchemy deploy lease/v1/projects/{projectId}/branches/{branchId}/alchemy-state/leasePOSTAcquire Alchemy deploy lease/v1/projects/{projectId}/branches/{branchId}/alchemy-state/leaseGETList Alchemy stacks/v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacksDELETEDelete Alchemy stack state/v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}GETList Alchemy stages/v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}/stagesGETGet Alchemy stack output/v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}/stages/{stage}/outputPUTSet Alchemy stack output/v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}/stages/{stage}/outputGETList replaced Alchemy resources/v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}/stages/{stage}/replaced-resourcesGETList Alchemy resources/v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}/stages/{stage}/resourcesDELETEDelete Alchemy resource state/v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}/stages/{stage}/resources/{fqn}GETGet Alchemy resource state/v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}/stages/{stage}/resources/{fqn}PUTSet Alchemy resource state/v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}/stages/{stage}/resources/{fqn}GETAlchemy state store version/v1/projects/{projectId}/branches/{branchId}/alchemy-state/versionGETGet branch topology/v1/projects/{projectId}/branches/{branchId}/application-topologyPUTReplace branch topology/v1/projects/{projectId}/branches/{branchId}/application-topologyGETList SCM installations for a workspace/v1/scm-installationsPOSTCreate an SCM App installation intent/v1/scm-installations/install-intentsGETList repositories accessible to an SCM installation/v1/scm-installations/{installationId}/repositoriesGETList services/v1/servicesPOSTCreate service/v1/servicesDELETEDelete service/v1/services/{serviceId}GETGet service/v1/services/{serviceId}PATCHUpdate service/v1/services/{serviceId}GETList deployments/v1/services/{serviceId}/deploymentsPOSTCreate deployment/v1/services/{serviceId}/deploymentsGETList custom domains for a service/v1/services/{serviceId}/domainsPOSTCreate a custom domain/v1/services/{serviceId}/domainsPOSTPromote deployment/v1/services/{serviceId}/promotePOSTRoll a service back to an existing deployment/v1/services/{serviceId}/rollbackGETList source repositories/v1/source-repositoriesPOSTLink a source repository to a project/v1/source-repositoriesDELETEDisconnect a source repository/v1/source-repositories/{id}GETGet a source repository/v1/source-repositories/{id}POSTCreate a workspace/v1/workspaces

Agents1 operation

GETPoll an approval/v1/agent-approvals/{approvalId}

Buckets8 operations

GETList buckets/v1/bucketsPOSTCreate bucket/v1/bucketsDELETEDelete bucket/v1/buckets/{bucketId}GETGet bucket/v1/buckets/{bucketId}PATCHUpdate bucket/v1/buckets/{bucketId}GETList bucket keys/v1/buckets/{bucketId}/keysPOSTCreate bucket key/v1/buckets/{bucketId}/keysDELETEDelete bucket key/v1/buckets/{bucketId}/keys/{keyId}
Documentation menu