Prisma

Prisma [Experimental] API

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

GitHub OpenAPI
Business capability
Deployment Orchestration BC-4210.40

Operations 70

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/apps List apps (deprecated, use services) · List apps #
Ask an LLM
“Which legacy apps does my token have access to?”
“Can I still list apps by project now that apps are deprecated?”
Tell an agent
List my deprecated apps.
List the legacy apps in project {projectId}.
POST /v1/apps Create an app (deprecated, use services) · Create app #
Ask an LLM
“Is creating an app still supported now that apps are deprecated?”
“What do I need to create a legacy app in a project?”
Tell an agent
Create a legacy app called {displayName} in project {projectId}.
Set up deprecated app {displayName} for {projectId} in region {regionId}.
GET /v1/apps/{appId} Get an app (deprecated) · Get app #
Ask an LLM
“Can I still look up a legacy app and its promoted deployment?”
“Which region is my old app running in?”
Tell an agent
Get legacy app {appId}.
Show region and live deployment of deprecated app {appId}.
PATCH /v1/apps/{appId} Rename an app (deprecated) · Update app #
Ask an LLM
“Can I rename a legacy app?”
“Is it possible to move an old app onto another git branch?”
Tell an agent
Rename legacy app {appId} to {displayName}.
Attach deprecated app {appId} to git branch {branchGitName}.
DELETE /v1/apps/{appId} Delete an app (deprecated) · Delete app #
Ask an LLM
“Are an app's deployments removed when I delete the legacy app?”
“Can I still delete an app through the deprecated apps endpoint?”
Tell an agent destructive · confirm first
Delete legacy app {appId}.
Remove deprecated app {appId} and its deployments.
POST /v1/apps/{appId}/promote Promote a deployment on an app (deprecated) · Promote deployment #
Ask an LLM
“Can I still make a running deployment live on a legacy app?”
“Does promoting on the old app endpoint require the deployment to be running?”
Tell an agent
Promote deployment {deploymentId} on legacy app {appId}.
Make {deploymentId} the active deployment behind deprecated app {appId}.
POST /v1/apps/{appId}/rollback Roll an app back to a deployment (deprecated) · Roll an app back to an existing deployment #
Ask an LLM
“Can I roll a legacy app back to an earlier deployment without downtime?”
“Will rolling back an old app start a stopped deployment first?”
Tell an agent
Roll legacy app {appId} back to deployment {deploymentId}.
Put {deploymentId} live again on deprecated app {appId}.
GET /v1/apps/{appId}/domains List an app's custom domains (deprecated) · List custom domains for an app #
Ask an LLM
“Which custom domains are attached to my legacy app?”
“Can I see domains across all deployments of an old app?”
Tell an agent
List custom domains on legacy app {appId}.
Show the hostnames bound to deprecated app {appId}.
POST /v1/apps/{appId}/domains Add a custom domain to an app (deprecated) · Create a custom domain #
Ask an LLM
“Can I still register a custom hostname on a legacy app?”
“What DNS setup does a custom domain on an old app need?”
Tell an agent
Add custom domain {hostname} to legacy app {appId}.
Register {hostname} for deprecated app {appId}.
GET /v1/apps/{appId}/deployments List an app's deployments (deprecated) · List deployments #
Ask an LLM
“Which deployments does my legacy app have?”
“Are an old app's deployments listed newest first?”
Tell an agent
List deployments of legacy app {appId}.
Show {limit} recent deployments for deprecated app {appId}.
POST /v1/apps/{appId}/deployments Create a deployment for an app (deprecated) · Create deployment #
Ask an LLM
“Can I still create a deployment under a legacy app?”
“Can a new deployment on an old app reuse the current artifact instead of uploading code?”
Tell an agent
Create a deployment for legacy app {appId}.
Deploy deprecated app {appId} again with skipCodeUpload {skipCodeUpload}.
GET /v1/services List compute services · List services #
Ask an LLM
“Which compute services can my token access?”
“Can I list the services in one project or git branch?”
Tell an agent
List my compute services.
List services in project {projectId}.
POST /v1/services Create a compute service · Create service #
Ask an LLM
“How do I create a compute service in a project?”
“Can I choose the region a new service runs in?”
Tell an agent
Create a service called {displayName} in project {projectId}.
Set up service {displayName} for {projectId} in region {regionId}.
GET /v1/services/{serviceId} Get a compute service · Get service #
Ask an LLM
“Which deployment is currently promoted on my service?”
“What region is a given compute service in?”
Tell an agent
Get service {serviceId}.
Show region and live deployment of service {serviceId}.
PATCH /v1/services/{serviceId} Rename a compute service · Update service #
Ask an LLM
“Can I rename a compute service?”
“Is it possible to move a service onto a different git branch?”
Tell an agent
Rename service {serviceId} to {displayName}.
Attach service {serviceId} to git branch {branchGitName}.
DELETE /v1/services/{serviceId} Delete a compute service · Delete service #
Ask an LLM
“Does deleting a service also delete its deployments?”
“How do I tear down a compute service completely?”
Tell an agent destructive · confirm first
Delete service {serviceId}.
Remove service {serviceId} along with all its deployments.
POST /v1/services/{serviceId}/promote Promote a running deployment on a service · Promote deployment #
Ask an LLM
“How do I make a running deployment live behind my service's stable endpoint?”
“Does a deployment have to be running before I promote it?”
Tell an agent
Promote deployment {deploymentId} on service {serviceId}.
Make {deploymentId} the active deployment behind service {serviceId}.
POST /v1/services/{serviceId}/rollback Roll a service back to an earlier deployment · Roll a service back to an existing deployment #
Ask an LLM
“Can I roll my service back to an earlier deployment with zero downtime?”
“Will a rollback start a stopped deployment before switching traffic?”
Tell an agent
Roll service {serviceId} back to deployment {deploymentId}.
Put {deploymentId} live again on service {serviceId}.
GET /v1/services/{serviceId}/domains List a service's custom domains · List custom domains for a service #
Ask an LLM
“Which custom domains are attached to my service?”
“Are domains shown across every deployment of a service?”
Tell an agent
List custom domains on service {serviceId}.
Show the hostnames bound to service {serviceId}.
POST /v1/services/{serviceId}/domains Add a custom domain to a service · Create a custom domain #
Ask an LLM
“How do I put my own hostname in front of a service?”
“What CNAME does a custom domain for a service need?”
Tell an agent
Add custom domain {hostname} to service {serviceId}.
Register {hostname} for service {serviceId}.
GET /v1/services/{serviceId}/deployments List a service's deployments · List deployments #
Ask an LLM
“Which deployments does my service have?”
“Are a service's deployments listed newest first?”
Tell an agent
List deployments of service {serviceId}.
Show {limit} recent deployments for service {serviceId}.
POST /v1/services/{serviceId}/deployments Create a deployment for a service · Create deployment #
Ask an LLM
“How do I create a new deployment and get an upload URL for my code?”
“Can a new deployment reuse the currently promoted artifact instead of uploading code?”
Tell an agent
Create a deployment for service {serviceId}.
Redeploy service {serviceId} with skipCodeUpload {skipCodeUpload}.
POST /v1/projects/{projectId}/branches Create a branch in a project · Create a branch #
Ask an LLM
“How do I add a preview branch to a project?”
“What happens when the first branch is created in a project?”
Tell an agent
Create branch {gitName} in project {projectId}.
Add branch {gitName} to {projectId} as the default with isDefault {isDefault}.
GET /v1/projects/{projectId}/branches List a project's branches · List branches in a project #
Ask an LLM
“Which live branches does my project have?”
“Can I find a branch by its exact git name?”
Tell an agent
List the branches in project {projectId}.
Find the branch named {gitName} in {projectId}.
GET /v1/branches/{branchId} Get a branch · Get a branch #
Ask an LLM
“What are the details of one branch?”
“Can I check whether a branch is the project default?”
Tell an agent
Get branch {branchId}.
Show me the git name and role of branch {branchId}.
PATCH /v1/branches/{branchId} Make a branch the project default · Update a branch #
Ask an LLM
“How do I change which branch is my project's default?”
“Can I rename a branch's git name after it is created?”
Tell an agent
Make branch {branchId} the project default.
Set isDefault to {isDefault} on branch {branchId}.
DELETE /v1/branches/{branchId} Soft-delete a branch · Soft-delete a branch #
Ask an LLM
“Why would deleting a branch be refused?”
“Can I delete a branch that still has databases or services on it?”
Tell an agent destructive · confirm first
Delete branch {branchId}.
Soft-delete preview branch {branchId}.
POST /v1/builds Report a build from CI or the CLI · Report a build #
Ask an LLM
“How do I record a CI build so it shows up in the platform?”
“Can reporting the same CI run twice create a duplicate build?”
Tell an agent
Report a {source} build of commit {commitSha} on branch {branchName}.
Record build run {runIdentity} for {commitSha} on {branchName} from {source}.
GET /v1/builds List builds in my workspace · List builds #
Ask an LLM
“Which builds ran recently in my workspace?”
“Can I see only the failed builds for one project?”
Tell an agent
List my recent builds.
Show builds in project {projectId} with state {state}.
PATCH /v1/builds/{buildId} Report progress on a build · Update a build #
Ask an LLM
“How do I mark a build as failed and record the failing step?”
“Can I add the deployed URL to a build after it finishes?”
Tell an agent
Set build {buildId} to state {state}.
Mark build {buildId} failed at step {failingStep} with error {errorMessage}.
GET /v1/builds/{buildId} Get a build and the resources it touched · Get a build #
Ask an LLM
“What resources did a particular build act on?”
“Where can I see the state of one build?”
Tell an agent
Get build {buildId}.
Show the resources build {buildId} reported acting on.
PUT /v1/builds/{buildId}/resources/{resourceType}/{resourceId} Record a resource a build acted on · Report a resource a build acted on #
Ask an LLM
“How do I record that a build created or deleted a database?”
“Can re-reporting a resource weaken the action already recorded on a build?”
Tell an agent
Record that build {buildId} {action} {resourceType} {resourceId}.
Log provenance: build {buildId} acted on {resourceType} {resourceId} with action {action}.
GET /v1/builds/{buildId}/logs Stream a build's logs · Stream build logs #
Ask an LLM
“How do I tail the logs of a build that is still running?”
“Can I resume reading build logs from where I stopped?”
Tell an agent
Show the build log for {buildId}.
Follow build {buildId}'s log live with follow set to {follow}.
GET /v1/domains/{domainId} Get a custom domain · Get a custom domain #
Ask an LLM
“What is the verification and certificate status of my custom domain?”
“Where do I look up one custom domain by its ID?”
Tell an agent
Get custom domain {domainId}.
Check the provisioning status of domain {domainId}.
DELETE /v1/domains/{domainId} Remove a custom domain · Delete a custom domain #
Ask an LLM
“How do I unbind a custom domain from my service?”
“Can I remove a hostname I no longer own?”
Tell an agent destructive · confirm first
Delete custom domain {domainId}.
Unbind hostname {domainId} from its service.
POST /v1/domains/{domainId}/retry Retry custom domain provisioning · Retry custom domain provisioning #
Ask an LLM
“My custom domain failed verification; can I retry the DNS check?”
“Is there a way to reissue the certificate for a pending domain?”
Tell an agent
Retry provisioning for domain {domainId}.
Re-run DNS verification and certificate issuance for {domainId}.
GET /v1/deployments/{deploymentId} Get a deployment's status · Get deployment #
Ask an LLM
“Is my deployment running yet?”
“What status does a given deployment have right now?”
Tell an agent
Get deployment {deploymentId}.
Check whether deployment {deploymentId} is running.
DELETE /v1/deployments/{deploymentId} Delete a stopped deployment · Delete deployment #
Ask an LLM
“Do I need to stop a deployment before deleting it?”
“Does deleting a deployment remove its VM too?”
Tell an agent destructive · confirm first
Delete deployment {deploymentId}.
Permanently remove {deploymentId} and its VM.
POST /v1/deployments/{deploymentId}/start Start a deployment's VM · Start deployment #
Ask an LLM
“How do I boot a deployment after uploading its artifact?”
“Where do I get the preview domain for a newly started deployment?”
Tell an agent
Start deployment {deploymentId}.
Boot the VM for {deploymentId} and give me its preview domain.
POST /v1/deployments/{deploymentId}/stop Stop a deployment's VM · Stop deployment #
Ask an LLM
“Can I shut down a deployment but keep its record?”
“What should I poll to confirm a deployment has stopped?”
Tell an agent
Stop deployment {deploymentId}.
Shut down the VM behind {deploymentId}.
GET /v1/deployments/{deploymentId}/logs Get a deployment's runtime logs · Get deployment logs #
Ask an LLM
“How do I see the last lines my deployment logged?”
“Can I read a deployment's logs from the very beginning?”
Tell an agent
Show logs for deployment {deploymentId}.
Get the last {tail} log lines of {deploymentId}.
POST /v1/projects/{projectId}/branches/{branchId}/alchemy-state/lease Acquire an Alchemy deploy lease · Acquire Alchemy deploy lease #
Ask an LLM
“How do I take the Alchemy deploy lease for a stack and stage?”
“What happens if another deploy already holds the lease?”
Tell an agent
Acquire the deploy lease for stack {stack} stage {stage} on branch {branchId} of {projectId}.
Take the lease on {stack}/{stage} in {projectId} branch {branchId} for {ttlSeconds} seconds.
PATCH /v1/projects/{projectId}/branches/{branchId}/alchemy-state/lease Extend an Alchemy deploy lease · Heartbeat Alchemy deploy lease #
Ask an LLM
“How do I keep my Alchemy deploy lease alive during a long deploy?”
“Can an expired lease be revived with a heartbeat?”
Tell an agent
Heartbeat lease {lease} on branch {branchId} of {projectId}.
Extend lease {lease} for {projectId} branch {branchId} by {ttlSeconds} seconds.
DELETE /v1/projects/{projectId}/branches/{branchId}/alchemy-state/lease Release an Alchemy deploy lease · Release Alchemy deploy lease #
Ask an LLM
“How do I give up the Alchemy lease when a deploy exits cleanly?”
“What does it mean if releasing my lease returns not found?”
Tell an agent destructive · confirm first
Release lease {lease} on branch {branchId} of project {projectId}.
Drop deploy lease {lease} for {projectId} branch {branchId}.
GET /v1/projects/{projectId}/branches/{branchId}/alchemy-state/version Get the Alchemy state store version · Alchemy state store version #
Ask an LLM
“Which Alchemy state store contract version does the platform serve?”
“Does checking the state store version need authentication?”
Tell an agent
Get the Alchemy state store version for branch {branchId} of {projectId}.
Probe the state API contract version on {projectId} branch {branchId}.
GET /v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks List Alchemy stacks on a branch · List Alchemy stacks #
Ask an LLM
“Which Alchemy stacks have stored state on my branch?”
“Can I list stack names without holding a deploy lease?”
Tell an agent
List the Alchemy stacks on branch {branchId} of {projectId}.
Show stack names with state in {projectId} branch {branchId}.
GET /v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}/stages List stages of an Alchemy stack · List Alchemy stages #
Ask an LLM
“Which stages of an Alchemy stack have stored state?”
“Does listing a stack's stages require a lease?”
Tell an agent
List stages of stack {stack} on branch {branchId} of {projectId} with lease {lease}.
Show the stage names stored for {stack} in {projectId}/{branchId} using lease {lease}.
GET /v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}/stages/{stage}/resources List resources in an Alchemy stage · List Alchemy resources #
Ask an LLM
“Which resources are recorded for an Alchemy stage?”
“In what order are a stage's resource FQNs returned?”
Tell an agent
List resource FQNs in {stack}/{stage} on {projectId} branch {branchId} with lease {lease}.
Show what resources stage {stage} of {stack} tracks in {projectId}/{branchId}, lease {lease}.
GET /v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}/stages/{stage}/resources/{fqn} Read one Alchemy resource's state · Get Alchemy resource state #
Ask an LLM
“How do I read the stored state of one Alchemy resource?”
“What comes back when a resource has no stored state?”
Tell an agent
Get state of resource {fqn} in {stack}/{stage} on {projectId} branch {branchId}, lease {lease}.
Read stored state for {fqn} ({stack} {stage}) in {projectId}/{branchId} with lease {lease}.
PUT /v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}/stages/{stage}/resources/{fqn} Save one Alchemy resource's state · Set Alchemy resource state #
Ask an LLM
“How do I store updated state for an Alchemy resource?”
“Is Alchemy resource state encrypted when it is saved?”
Tell an agent
Save state for resource {fqn} in {stack}/{stage} on {projectId} branch {branchId}, lease {lease}.
Write {fqn}'s new state to stage {stage} of {stack} in {projectId}/{branchId} under lease {lease}.
DELETE /v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}/stages/{stage}/resources/{fqn} Delete one Alchemy resource's state · Delete Alchemy resource state #
Ask an LLM
“How do I remove the stored state row for one Alchemy resource?”
“Is deleting a resource state that doesn't exist an error?”
Tell an agent destructive · confirm first
Delete state for resource {fqn} in {stack}/{stage} on {projectId} branch {branchId}, lease {lease}.
Forget {fqn} from stage {stage} of {stack} in {projectId}/{branchId} using lease {lease}.
GET /v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}/stages/{stage}/replaced-resources List replaced Alchemy resources in a stage · List replaced Alchemy resources #
Ask an LLM
“Which Alchemy resources in a stage are marked as replaced?”
“Can I see the decrypted state of resources awaiting cleanup after replacement?”
Tell an agent
List replaced resources in {stack}/{stage} on {projectId} branch {branchId}, lease {lease}.
Show replaced-status resource states for stage {stage} of {stack} in {projectId}/{branchId}, lease {lease}.
GET /v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}/stages/{stage}/output Read an Alchemy stack's output · Get Alchemy stack output #
Ask an LLM
“How do I read the stored output of an Alchemy stack stage?”
“What is returned if a stage has no stack output yet?”
Tell an agent
Get the stack output of {stack}/{stage} on {projectId} branch {branchId}, lease {lease}.
Read outputs saved for stage {stage} of {stack} in {projectId}/{branchId} with lease {lease}.
PUT /v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack}/stages/{stage}/output Overwrite an Alchemy stack's output · Set Alchemy stack output #
Ask an LLM
“How do I save new outputs for an Alchemy stack stage?”
“Does writing stack output replace what was stored before?”
Tell an agent
Overwrite the stack output of {stack}/{stage} on {projectId} branch {branchId}, lease {lease}.
Store fresh outputs for stage {stage} of {stack} in {projectId}/{branchId} under lease {lease}.
DELETE /v1/projects/{projectId}/branches/{branchId}/alchemy-state/state/stacks/{stack} Delete all state for an Alchemy stack · Delete Alchemy stack state #
Ask an LLM
“How do I wipe all stored state and outputs for an Alchemy stack?”
“Can I clear state for just one stage of a stack?”
Tell an agent destructive · confirm first
Delete all state for stack {stack} on {projectId} branch {branchId} with lease {lease}.
Clear only stage {stage} rows of stack {stack} in {projectId}/{branchId}, lease {lease}.
PUT /v1/projects/{projectId}/branches/{branchId}/application-topology Replace a branch's application topology · Replace branch topology #
Ask an LLM
“How do I replace the whole application topology for a branch?”
“Is the previous topology kept if replacing it fails?”
Tell an agent
Replace the topology of branch {branchId} in {projectId} with nodes {nodes}, ports {ports} and edges {edges}.
Upload topology hash {contentHash} with {nodes}, {ports}, {edges} to {projectId}/{branchId}.
GET /v1/projects/{projectId}/branches/{branchId}/application-topology Get a branch's application topology · Get branch topology #
Ask an LLM
“What does the application topology graph for my branch look like?”
“Can I see the nodes, ports and edges Composer submitted?”
Tell an agent
Get the application topology for branch {branchId} of {projectId}.
Show the topology graph stored for {projectId} branch {branchId}.
POST /v1/environment-variables Create an environment variable · Create an environment variable #
Ask an LLM
“How do I add a secret to my project's production environment?”
“Can I override an environment variable for one preview branch?”
Tell an agent
Set {key} to {value} in the {class_} environment of project {projectId}.
Add a {class_} override of {key}={value} for branch {branchId} in {projectId}.
GET /v1/environment-variables List environment variables · List environment variables #
Ask an LLM
“Which environment variables are set for my project?”
“Can I look up one variable by its key and environment class?”
Tell an agent
List the environment variables in project {projectId}.
Find variable {key} in the {class_} environment of {projectId}.
PATCH /v1/environment-variables/{envVarId} Change an environment variable's value · Update an environment variable's value #
Ask an LLM
“How do I rotate the value of an existing environment variable?”
“Can I change a variable's key or environment after creating it?”
Tell an agent
Update variable {envVarId} to {value}.
Replace the value of {envVarId} with {value}.
GET /v1/environment-variables/{envVarId} Get an environment variable's metadata · Get an environment variable #
Ask an LLM
“Can I read back the value of an environment variable?”
“What metadata is stored for a single environment variable?”
Tell an agent
Get environment variable {envVarId}.
Show the metadata of variable {envVarId}.
DELETE /v1/environment-variables/{envVarId} Delete an environment variable · Delete an environment variable #
Ask an LLM
“How do I remove an environment variable I no longer use?”
“What happens if I delete the same variable twice?”
Tell an agent destructive · confirm first
Delete environment variable {envVarId}.
Remove variable {envVarId} from its environment.
POST /v1/auth/github-actions/token Exchange a GitHub Actions OIDC token · Exchange a GitHub Actions OIDC token for a workspace service token #
Ask an LLM
“How do I get a workspace token in GitHub Actions without storing a secret?”
“How long does a service token minted from GitHub Actions last?”
Tell an agent
Exchange GitHub Actions OIDC token {oidc_token} for a workspace service token.
Mint a service token from {oidc_token} valid for {expiresInSeconds} seconds.
GET /v1/scm-installations List a workspace's SCM installations · List SCM installations for a workspace #
Ask an LLM
“Which source control app installations are connected to my workspace?”
“Is the GitHub app installed for this workspace?”
Tell an agent
List SCM installations for workspace {workspaceId}.
Show the active source control connections of {workspaceId}.
POST /v1/scm-installations/install-intents Start installing the SCM app · Create an SCM App installation intent #
Ask an LLM
“How do I connect GitHub to my Prisma workspace?”
“Which source control providers can I install the app for?”
Tell an agent
Create a {provider} install link for workspace {workspaceId}.
Start the {provider} app installation for {workspaceId}.
GET /v1/scm-installations/{installationId}/repositories List repositories an SCM installation can see · List repositories accessible to an SCM installation #
Ask an LLM
“Which repositories can my connected SCM installation access?”
“Can I page through the repos available to an installation?”
Tell an agent
List repositories for installation {installationId}.
Show {limit} repos accessible to {installationId}.
POST /v1/source-repositories Link a repository to a project · Link a source repository to a project #
Ask an LLM
“How do I link a GitHub repository to a Prisma project?”
“Which installation should I use when connecting a repo?”
Tell an agent
Link {provider} repository {providerRepositoryId} to project {projectId}.
Connect repo {providerRepositoryId} to {projectId} through installation {installationId} on {provider}.
GET /v1/source-repositories List repositories linked to a project · List source repositories #
Ask an LLM
“Which repositories are linked to my project?”
“Do I need a project ID to list linked source repositories?”
Tell an agent
List source repositories linked to project {projectId}.
Show the repos connected to {projectId}.
DELETE /v1/source-repositories/{id} Disconnect a source repository · Disconnect a source repository #
Ask an LLM
“Are branches and resources kept when I disconnect a repository?”
“How do I unlink a repo from my project?”
Tell an agent destructive · confirm first
Disconnect source repository {id}.
Unlink repository {id} from its project.
GET /v1/source-repositories/{id} Get a linked source repository · Get a source repository #
Ask an LLM
“What are the details of one linked source repository?”
“Where do I look up a repository link by its ID?”
Tell an agent
Get source repository link {id}.
Show linked repository {id}.

Documentation

📖
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
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/rate-limits/prisma-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/openapi/prisma-experimental-api-openapi.yml

Other Resources

🔗
SDKs
https://www.prisma.io/docs/rest-api/sdk
🔗
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
🔗
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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/prisma:prisma-experimental-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

prisma-experimental-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Prisma Postgres Management [Experimental] API
  description: REST API for managing Prisma Postgres projects, databases, backups, and workspaces.
  version: v1
servers:
- url: https://api.prisma.io
security:
- OAuth2:
  - workspace:admin
  - offline_access
- Bearer: []
tags:


# --- truncated at 32 KB (384 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/prisma/refs/heads/main/openapi/prisma-experimental-api-openapi.yml