# Prisma Postgres Management API

**Canonical:** https://apis.io/apis/prisma/prisma-postgres-management-api/  
**Provider:** Prisma — https://apis.io/providers/prisma/  
**Base URL:** https://api.prisma.io/v1  
**Documentation:** https://www.prisma.io/docs/rest-api

Prisma Postgres Management API is one of 24 APIs that [Prisma](https://apis.io/providers/prisma/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Database, Postgres, Developer Tools, Application Hosting, and Object Storage. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

The provider-published REST control plane for Prisma. 115 operations across 72 paths covering workspaces, projects, Prisma Postgres databases, connection strings, backups, usage, object-store buckets and keys, service tokens, integrations and regions, plus the Prisma Compute surface (apps, services, deployments, branches, builds, domains, environment variables and source repositories) marked experimental in the contract itself. Authenticated with a never-expiring service token or OAuth 2.0 + PKCE against auth.prisma.io.

## Operations (60 of 115)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/apps` | List apps |
| POST | `/v1/apps` | Create app |
| GET | `/v1/apps/{appId}` | Get app |
| PATCH | `/v1/apps/{appId}` | Update app |
| DELETE | `/v1/apps/{appId}` | Delete app |
| POST | `/v1/apps/{appId}/promote` | Promote deployment |
| POST | `/v1/apps/{appId}/rollback` | Roll an app back to an existing deployment |
| GET | `/v1/apps/{appId}/domains` | List custom domains for an app |
| POST | `/v1/apps/{appId}/domains` | Create a custom domain |
| GET | `/v1/apps/{appId}/deployments` | List deployments |
| POST | `/v1/apps/{appId}/deployments` | Create deployment |
| GET | `/v1/services` | List services |
| POST | `/v1/services` | Create service |
| GET | `/v1/services/{serviceId}` | Get service |
| PATCH | `/v1/services/{serviceId}` | Update service |
| DELETE | `/v1/services/{serviceId}` | Delete service |
| POST | `/v1/services/{serviceId}/promote` | Promote deployment |
| POST | `/v1/services/{serviceId}/rollback` | Roll a service back to an existing deployment |
| GET | `/v1/services/{serviceId}/domains` | List custom domains for a service |
| POST | `/v1/services/{serviceId}/domains` | Create a custom domain |
| GET | `/v1/services/{serviceId}/deployments` | List deployments |
| POST | `/v1/services/{serviceId}/deployments` | Create deployment |
| POST | `/v1/projects/{projectId}/branches` | Create a branch |
| GET | `/v1/projects/{projectId}/branches` | List branches in a project |
| GET | `/v1/branches/{branchId}` | Get a branch |
| PATCH | `/v1/branches/{branchId}` | Update a branch |
| DELETE | `/v1/branches/{branchId}` | Soft-delete a branch |
| GET | `/v1/buckets` | List buckets |
| POST | `/v1/buckets` | Create bucket |
| GET | `/v1/buckets/{bucketId}` | Get bucket |
| DELETE | `/v1/buckets/{bucketId}` | Delete bucket |
| GET | `/v1/buckets/{bucketId}/keys` | List bucket keys |
| POST | `/v1/buckets/{bucketId}/keys` | Create bucket key |
| DELETE | `/v1/buckets/{bucketId}/keys/{keyId}` | Delete bucket key |
| POST | `/v1/builds` | Report a build |
| GET | `/v1/builds` | List builds |
| PATCH | `/v1/builds/{buildId}` | Update a build |
| GET | `/v1/builds/{buildId}` | Get a build |
| PUT | `/v1/builds/{buildId}/resources/{resourceType}/{resourceId}` | Report a resource a build acted on |
| GET | `/v1/builds/{buildId}/logs` | Stream build logs |
| GET | `/v1/domains/{domainId}` | Get a custom domain |
| DELETE | `/v1/domains/{domainId}` | Delete a custom domain |
| POST | `/v1/domains/{domainId}/retry` | Retry custom domain provisioning |
| GET | `/v1/connections` | List connections |
| POST | `/v1/connections` | Create connection |
| GET | `/v1/connections/{id}` | Get connection |
| DELETE | `/v1/connections/{id}` | Delete connection |
| POST | `/v1/connections/{id}/rotate` | Rotate connection credentials |
| GET | `/v1/databases` | List databases |
| POST | `/v1/databases` | Create database |
| GET | `/v1/databases/{databaseId}` | Get database |
| PATCH | `/v1/databases/{databaseId}` | Update database |
| DELETE | `/v1/databases/{databaseId}` | Delete database |
| GET | `/v1/databases/{databaseId}/connections` | Get list of database connections |
| POST | `/v1/databases/{databaseId}/connections` | Create database connection string |
| GET | `/v1/databases/{databaseId}/backups` | Get list of backups |
| POST | `/v1/databases/{targetDatabaseId}/restore` | Restore database (destructive) |
| GET | `/v1/databases/{databaseId}/usage` | Get database usage metrics |
| GET | `/v1/deployments/{deploymentId}` | Get deployment |
| DELETE | `/v1/deployments/{deploymentId}` | Delete deployment |

…and 55 more operations. They are listed in full on the page.

## Machine-readable artifacts (29)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/openapi/prisma-postgres-management-api-openapi.json
- **OpenAPI** — https://www.prisma.io/openapi.json
- **OpenAPI** — https://api.prisma.io/v1/doc
- **Documentation** — https://www.prisma.io/docs/rest-api
- **APIReference** — https://api.prisma.io/v1/swagger-editor
- **GettingStarted** — https://www.prisma.io/docs/rest-api/getting-started
- **Authentication** — https://www.prisma.io/docs/rest-api/authentication
- **SDKs** — https://www.prisma.io/docs/rest-api/sdk
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/overlays/prisma-postgres-management-api-overlay.yaml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/data-model/prisma-data-model.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/errors/prisma-problem-types.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/conventions/prisma-conventions.yml
- **Idempotency** — https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/conventions/prisma-conventions.yml
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/rate-limits/prisma-rate-limits.yml
- **OAuthScopes** — https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/scopes/prisma-scopes.yml
- **ToolCrosswalk** — https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/mcp/prisma-tool-crosswalk.yml
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/apis.yml
- **Arazzo** — https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/arazzo/prisma-accelerate-query-and-invalidate-workflow.yml
- **Arazzo** — https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/arazzo/prisma-client-list-and-count-records-workflow.yml
- **Arazzo** — https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/arazzo/prisma-client-upsert-record-workflow.yml
- **Arazzo** — https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/arazzo/prisma-optimize-record-and-analyze-workflow.yml
- **Arazzo** — https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/arazzo/prisma-platform-bootstrap-environment-workflow.yml
- **Arazzo** — https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/arazzo/prisma-platform-rotate-api-key-workflow.yml
- **Arazzo** — https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/arazzo/prisma-postgres-add-database-to-project-workflow.yml
- **Arazzo** — https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/arazzo/prisma-postgres-backup-and-restore-workflow.yml
- **Arazzo** — https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/arazzo/prisma-postgres-find-and-delete-project-workflow.yml
- **Arazzo** — https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/arazzo/prisma-postgres-provision-project-workflow.yml
- **Arazzo** — https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/arazzo/prisma-postgres-rotate-connection-workflow.yml
- **Arazzo** — https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/arazzo/prisma-pulse-named-stream-resume-workflow.yml

## Other Prisma APIs (12)

- [Prisma Aggregation API](https://apis.io/apis/prisma/prisma-aggregation-api/)
- [Prisma API Keys API](https://apis.io/apis/prisma/prisma-api-keys-api/)
- [Prisma Batch API](https://apis.io/apis/prisma/prisma-batch-api/)
- [Prisma Cache API](https://apis.io/apis/prisma/prisma-cache-api/)
- [Prisma Connections API](https://apis.io/apis/prisma/prisma-connections-api/)
- [Prisma CRUD API](https://apis.io/apis/prisma/prisma-crud-api/)
- [Prisma Database Backups API](https://apis.io/apis/prisma/prisma-database-backups-api/)
- [Prisma Database Usage API](https://apis.io/apis/prisma/prisma-database-usage-api/)
- [Prisma Databases API](https://apis.io/apis/prisma/prisma-databases-api/)
- [Prisma Environments API](https://apis.io/apis/prisma/prisma-environments-api/)
- [Prisma Events API](https://apis.io/apis/prisma/prisma-events-api/)
- [Prisma Health API](https://apis.io/apis/prisma/prisma-health-api/)

## Tags

Database, Postgres, Developer Tools, Application Hosting, Object Storage, Provisioning

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/prisma/prisma-postgres-management-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/prisma/.
