Prisma integration: operations for AI agents
Prisma connects to Type.com as an integration. This page lists the 106 operations documented for Claude and Codex in Type.com: 50 read, 34 write, 22 destructive.
About Prisma
Prisma Data Platform provides database tools including Accelerate (global database cache), Optimize (AI-driven query analysis), and Prisma Postgres (managed PostgreSQL). Manage workspaces, projects, environments, and API keys programmatically.
Categories: Developer Tools & IT
How to connect Prisma to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
106 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
106 operations listed.
Agents
- Read
Poll an approval
Reports where an approval stands, so an agent holding an approvalrequired response can wait for the sponsor's decision and retry. Only the agent the approval belongs to can read it.
[Experimental]
- Read
List services
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Returns all services the token has access to, ordered by creation time (oldest first). Optionally filter by project ID. Supports cursor-based pagination.
- Read
Get service
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Returns a service by ID, including its region and active promoted deployment reference.
- Read
List custom domains for a service
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Returns all custom domains attached to any deployment of the service. Domains are aggregated across all deployments since Foundry lists per deployment.
- Read
List deployments
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Returns all deployments belonging to a service, ordered by creation time (newest first). Supports cursor-based pagination.
- Read
List branches in a project
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Returns the live Branches of a Project. Supports two mutually exclusive filters: ?gitName= (exact match — at most one row), ?gitNameContains= (case-sensitive substring).
- Read
Get a branch
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Returns a single Branch by ID. Member resources are not inlined — list them via /v1/databases?branchId= and /v1/apps?branchId=.
- Read
List builds
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Lists the builds of the caller's workspace, newest first, filtered by project, branch, or state. cursor is opaque: pass back the nextCursor the previous page returned.
- Read
Get a build
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Returns one build with the resources it reported acting on.
- Read
Get a custom domain
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Returns details for a custom domain by id. Authorization is derived from the parent compute service's workspace.
- Read
Get deployment
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Returns a deployment by ID, including its current status derived from the underlying VM state.
- Read
Get deployment logs
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Returns log output for the specified deployment.
- Read
Alchemy state store version
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Unauthenticated contract-version probe served verbatim from the pinned alchemy HttpStateApi contract.
- Read
List Alchemy stacks
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Lists the distinct stack names with state or output rows on the branch.
- Read
List Alchemy stages
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Lists the distinct stage names with state or output rows for the stack. Accepts a live deploy lease on any stage of the stack.
- Read
List Alchemy resources
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Lists the resource FQNs stored for the stage, ordered by FQN.
- Read
Get Alchemy resource state
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Returns the stored resource state, or a JSON null body when absent (the stock client maps null to undefined).
- Read
List replaced Alchemy resources
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Returns the decrypted resource states of the stage whose status is "replaced".
- Read
Get Alchemy stack output
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Returns the stored stack output for the stage, or a JSON null body when absent (the stock client maps null to undefined).
- Read
Get branch topology
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Returns the stored topology graph for the branch — the same shape Composer submitted. Nodes, ports, and edges are returned in deterministic order.
- Read
List environment variables
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Returns a paginated list of environment variables. All filters are optional; combine projectId, class, and key to look up a specific variable by name.
- Read
Get an environment variable
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Returns a single environment variable's metadata. The value is not returned.
- Read
List SCM installations for a workspace
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Lists active SCM installations connected to the given workspace.
- Read
List repositories accessible to an SCM installation
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Lists repositories accessible to the given SCM installation.
- Read
List source repositories
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Returns source repositories linked to a project. Requires projectId query parameter.
- Read
Get a source repository
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Returns a single source repository link by ID.
- Write
Create service
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Creates a new service under the specified project. The projectId is required in the request body.
- Write
Update service
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Updates the display name, logical id, or branch of a service.
- Write
Promote deployment
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Promotes a deployment to be the active deployment behind the service's stable endpoint. The deployment must be running. Returns the service endpoint domain.
- Write
Roll a service back to an existing deployment
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Makes any eligible existing deployment live behind the service's stable endpoint (rollback or roll-forward).
- Write
Create a custom domain
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Registers a custom hostname for the service. The hostname must CNAME to the regional switchboard target before DNS verification can succeed.
- Write
Create deployment
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Creates a new deployment under the specified service.
- Write
Create a branch
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Creates a Branch under the specified Project. The first Branch in a Project is always created with isDefault=true and role=production regardless of the body value.
- Write
Update a branch
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Promotes a Branch to be the Project's default. Only isDefault is mutable — gitName rename and role changes are rejected.
- Write
Report a build
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Records a build any deploy tool is running — a CI workflow, a deploy script, or Composer from a laptop.
- Write
Update a build
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Records progress on a build.
- Write
Retry custom domain provisioning
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Retries DNS verification and certificate issuance for a failed or pending domain. Returns 409 if the domain is not yet eligible for retry (e.g. still provisioning).
- Write
Start deployment
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Requests VM creation and startup for the deployment. The artifact must be uploaded before calling this endpoint.
- Write
Stop deployment
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Requests VM shutdown for the deployment. The deployment record and metadata are retained. Poll the status endpoint until stopped is reached.
- Write
Acquire Alchemy deploy lease
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Acquires the deploy lease for a (branch, stack, stage).
- Write
Heartbeat Alchemy deploy lease
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Extends the unexpired deploy lease addressed by the Alchemy-State-Lease-Id header from now.
- Write
Create an environment variable
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Creates a new environment variable in a project's production or preview environment, or a preview branch override when branchId is supplied.
- Write
Update an environment variable's value
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Replaces the value of an existing environment variable. Only the value is mutable — the project, environment, key, and branch are fixed at create-time.
- Write
Exchange a GitHub Actions OIDC token for a project-scoped service token
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Verifies the GitHub Actions OIDC token and mints a short-lived project-scoped service token. The caller must request the token with audience prisma-cloud.
- Write
Create an SCM App installation intent
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Creates an installation intent for the given workspace.
- Write
Link a source repository to a project
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Links a GitHub repository to a Prisma project via an existing SCM installation.
- Write
Create a workspace
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Creates a new free-plan workspace owned by the authenticated user.
- Destructive
Delete service
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Deletes a service. Deployments under the service are deleted before the service is deleted.
- Destructive
Soft-delete a branch
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Soft-deletes a Branch (sets deletedAt). Refuses if the Branch is the Project's current default, the Project's production Branch, or has live members.
- Destructive
Report a resource a build acted on
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Records that the build created, acted on, or deleted a platform resource — the provenance a deploy run leaves behind.
- Destructive
Delete a custom domain
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Removes a custom domain binding. Authorization is derived from the parent compute service's workspace.
- Destructive
Delete deployment
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Permanently deletes the deployment, its metadata, and any associated VM. The deployment must be stopped or in the new state before it can be deleted.
- Destructive
Release Alchemy deploy lease
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Releases the deploy lease addressed by the Alchemy-State-Lease-Id header on clean deploy exit.
- Destructive
Set Alchemy resource state
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Stores the resource state encrypted at rest and echoes the stored value.
- Destructive
Delete Alchemy resource state
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Deletes the resource state row. Idempotent: deleting an absent row also returns 204.
- Destructive
Set Alchemy stack output
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Overwrites the stack output for the stage, encrypted at rest, and echoes the stored value.
- Destructive
Delete Alchemy stack state
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Deletes every resource-state and output row of the stack, or only the given stage's rows when the stage query parameter is set.
- Destructive
Replace branch topology
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Atomically replaces the entire topology for a branch. Composer calls this after Load, before the apply.
- Destructive
Delete an environment variable
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Removes an environment variable. A second delete of the same variable returns 404.
- Destructive
Disconnect a source repository
⚠️ Experimental endpoint: this API is in active development and may change at any time without notice. ⚠️ Disconnects the source repository link. Existing branches and their attached resources are preserved.
Buckets
- Read
List buckets
Returns all object-store buckets the token has access to. Optionally filter by project ID.
- Read
Get bucket
Returns the bucket with the given ID.
- Read
List bucket keys
Returns all access keys for the given bucket.
- Write
Create bucket
Creates a new object-store bucket in the specified project.
- Write
Update bucket
Updates the display name, logical id, or branch of the bucket with the given ID. The display name is a label only: the provider bucket name, the objects, and the access keys do not change.
- Write
Create bucket key
Creates a new access key for the given bucket. The secretAccessKey field is returned exactly once in this response and is never stored — copy it immediately.
- Destructive
Delete bucket
Permanently deletes the bucket with the given ID, all objects stored in it, and all its access keys. This action cannot be undone.
- Destructive
Delete bucket key
Revokes and deletes the bucket key with the given ID.
Connections
- Read
List connections
Returns all connections the actor has access to, with optional database filter.
- Read
Get connection
Returns the connection with the given ID.
- Write
Create connection
Creates a new connection for the specified database.
- Write
Rotate connection credentials
Generates new credentials for the connection with the given ID. Revocation of the previous credentials is best-effort.
- Destructive
Delete connection
Deletes the connection with the given ID.
Databases
- Read
List databases
Returns all databases the token has access to. Optionally filter by project ID.
- Read
Get database
Returns the database with the given ID.
- Read
Get list of databases
Returns databases for the given project.
- Write
Create database
Creates a new database in the specified project. logicalId cannot be combined with branchGitName; pass branchId instead.
- Write
Update database
Updates the database with the given ID. logicalId cannot be combined with branchId or branchGitName in one request; move the database first, then set its logicalId.
- Write
Create database
Creates a new database for the given project.
- Destructive
Delete database
Deletes the database with the given ID.
- Destructive
Restore database (destructive)
⚠️ Destructive operation — this immediately and irreversibly overwrites all data in the target database with the contents of the specified backup. Any data written since the backup was taken will be lost. Ensure you have a recent backup of the target database before proceeding.
Databases Connections
- Read
Get list of database connections
Returns all connections for the given database.
- Write
Create database connection string
Creates a new connection string for the given database.
Database Backups
- Read
Get list of backups
Returns backups for the specified database.
Database Usage
- Read
Get database usage metrics
Returns usage metrics for the specified database.
Projects
- Read
Get list of projects
Returns the list of projects the token has access to.
- Read
Get project
Returns the project with the given ID.
- Write
Create project with a postgres database
Creates a new project with a postgres database.
- Write
Update project
Updates the project with the given ID.
- Write
Transfer project
Transfer the project with the given ID to the new owner's workspace
- Destructive
Delete project
Deletes the project with the given ID.
Integrations
- Read
Get list of integrations
Returns integrations filtered by workspace ID.
- Read
Get integration by ID
Returns a single integration by its ID.
- Read
Get list of integrations
Returns integrations for the given workspace.
- Destructive
Delete integration
Revokes the integration tokens by integration ID.
- Destructive
Revoke integration tokens
Revokes the integration tokens with the given client ID.
Misc
- Read
Get current authenticated principal
Returns the user, workspace, and credential represented by the current token.
- Read
Get Prisma Postgres regions
Returns all available regions for Prisma Postgres.
- Read
Get Prisma Accelerate regions
Returns all available regions for Prisma Accelerate.
Service Tokens
- Read
List service tokens
Returns the service tokens for the given workspace, newest first.
- Write
Create service token
Creates a new service token for the given workspace. The value field is returned exactly once in this response and is never stored — copy it immediately.
- Destructive
Delete service token
Revokes the service token with the given ID by deleting it.
Regions
- Read
Get all regions
Returns all available regions across products. Optionally filter by product.
Workspaces
- Read
Get list of workspaces
Returns the list of workspaces the current token can access.
- Read
Get workspace
Returns the workspace with the given ID.
- Read
Get workspace subscription
Returns subscription information for the workspace with the given ID.
No operations match.
See How connections work for access and permissions, or browse all integrations.