Prisma

Prisma Environments API

Operations for managing project environments

GitHub OpenAPI

Operations 4

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 /projects/{projectId}/environments List a project's environments · Prisma List environments for a project #
Ask an LLM
“Which environments, like staging and production, does my project have?”
“Can I see every deployment stage configured for a project?”
Tell an agent
List the environments in project {projectId}.
Show all deployment stages set up for {projectId}.
POST /projects/{projectId}/environments Create an environment in a project · Prisma Create an environment #
Ask an LLM
“How do I add a staging environment to my project?”
“What connection string does a new environment need?”
Tell an agent
Create environment {name} in project {projectId} using {connectionString}.
Add a {name} stage to {projectId} connected to {connectionString}.
GET /environments/{environmentId} Get an environment's configuration · Prisma Get an environment #
Ask an LLM
“Can I check an environment's connection configuration and API key status?”
“Where do I see details for a single environment?”
Tell an agent
Get environment {environmentId}.
Show the connection setup and API key status of {environmentId}.
DELETE /environments/{environmentId} Delete an environment and its API keys · Prisma Delete an environment #
Ask an LLM
“Does deleting an environment also delete its API keys?”
“Is removing an environment reversible?”
Tell an agent destructive · confirm first
Delete environment {environmentId}.
Permanently remove {environmentId} and its API keys.

Documentation

📖
Authentication
https://www.prisma.io/docs/rest-api/authentication
📖
GettingStarted
https://www.prisma.io/docs/console/getting-started
📖
Documentation
https://www.prisma.io/docs/accelerate
📖
GettingStarted
https://www.prisma.io/docs/accelerate/getting-started
📖
Documentation
https://www.prisma.io/docs/orm
📖
GettingStarted
https://www.prisma.io/docs/prisma-orm/quickstart/prisma-postgres
📖
GettingStarted
https://www.prisma.io/docs/query-insights

Specifications

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

Other Resources

🔗
Reference
https://www.prisma.io/docs/accelerate/reference/api-reference
🔗
FAQ
https://www.prisma.io/docs/accelerate/more/faq
🔗
SDKs
https://www.prisma.io/docs/rest-api/sdk
🔗
Reference
https://www.prisma.io/docs/orm/reference/prisma-client-reference
🔗
SDKs
https://www.npmjs.com/package/@prisma/client
🔗
SDKs
https://www.npmjs.com/package/@prisma/extension-optimize

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-environments-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-environments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Prisma Data Platform Environments API
  description: REST API for managing Prisma Data Platform resources including projects, environments, and database connections through the Prisma Console. Provides programmatic access to workspace management, API key generation, and platform resource configuration.
  version: 1.0.0
  contact:
    name: Prisma Support
    email: support@prisma.io
    url: https://www.prisma.io/support
  license:
    name: Proprietary
    url: https://www.prisma.io/terms
  termsOfService: https://www.prisma.io/terms
servers:
- url: https://api.cloud.prisma.io
  description: Prisma Data Platform production server
security:
- bearerAuth: []
tags:
- name: Environments
  description: Operations for managing project environments
paths:
  /projects/{projectId}/environments:
    get:
      operationId: listEnvironments
      summary: Prisma List environments for a project
      description: Retrieves all environments configured for a specific project. Environments represent different deployment stages such as development, staging, and production.
      tags:
      - Environments
      parameters:
      - $ref: '#/components/parameters/ProjectId'
      responses:
        '200':
          description: Successfully retrieved list of environments
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Environment'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalServerError'
    post:
      operationId: createEnvironment
      summary: Prisma Create an environment
      description: Creates a new environment within a project for a specific deployment stage with its own database connection and API key.
      tags:
      - Environments
      parameters:
      - $ref: '#/components/parameters/ProjectId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvironmentCreate'
      responses:
        '201':
          description: Successfully created environment
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /environments/{environmentId}:
    get:
      operationId: getEnvironment
      summary: Prisma Get an environment
      description: Retrieves detailed information about a specific environment including its connection configuration and API key status.
      tags:
      - Environments
      parameters:
      - $ref: '#/components/parameters/EnvironmentId'
      responses:
        '200':
          description: Successfully retrieved environment details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      operationId: deleteEnvironment
      summary: Prisma Delete an environment
      description: Permanently deletes an environment and its associated API keys. This action cannot be undone.
      tags:
      - Environments
      parameters:
      - $ref: '#/components/parameters/EnvironmentId'
      responses:
        '204':
          description: Successfully deleted environment
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  responses:
    RateLimited:
      description: Too many requests - rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The requested resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: The request was invalid or malformed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication is required or the provided credentials are invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: An unexpected error occurred on the server
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    EnvironmentCreate:
      type: object
      description: Request body for creating a new environment
      properties:
        name:
          type: string
          description: Display name for the new environment
          examples:
          - Staging
        connectionString:
          type: string
          description: Database connection string for the environment
      required:
      - name
      - connectionString
    Error:
      type: object
      description: Standard error response from the API
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable error code
            message:
              type: string
              description: Human-readable error message
            details:
              type: object
              description: Additional error context
              additionalProperties: true
          required:
          - code
          - message
    Environment:
      type: object
      description: An environment represents a deployment stage within a project, such as development, staging, or production, with its own database connection and API keys.
      properties:
        id:
          type: string
          description: Unique identifier for the environment
          examples:
          - env_abc123def456
        name:
          type: string
          description: Display name of the environment
          examples:
          - Production
        projectId:
          type: string
          description: Identifier of the parent project
        connectionString:
          type: string
          description: Database connection string for this environment
          examples:
          - prisma://accelerate.prisma-data.net/?api_key=ey...
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the environment was created
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when the environment was last updated
      required:
      - id
      - name
      - projectId
      - createdAt
      - updatedAt
  parameters:
    EnvironmentId:
      name: environmentId
      in: path
      required: true
      description: Unique identifier of the environment
      schema:
        type: string
    ProjectId:
      name: projectId
      in: path
      required: true
      description: Unique identifier of the project
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Authentication via service token or OAuth 2.0 access token. Service tokens are created in the Prisma Console under workspace settings.
externalDocs:
  description: Prisma Data Platform Documentation
  url: https://www.prisma.io/docs/platform/about