Using API Clients (/docs/rest-api/api-clients)

For the complete Prisma documentation index, see llms.txt. A markdown version of any docs page is available by appending .md to its URL.

Use the REST API with popular API clients like Postman, Insomnia, and Yaak

Location: REST API > Using API Clients

This guide shows you how to configure popular API clients to work with the REST API using OAuth 2.0 authentication.

Download the Postman collection to import all endpoints with OAuth2 auth pre-configured. Compatible with Postman, Yaak, Insomnia, and other clients that support the Postman Collection v2.1 format.

Postman is a popular API client with testing, collaboration, and automation features for working with REST APIs.

Before you begin, make sure you have:

• A Prisma Console account
• Postman installed

Register an OAuth2 application in Prisma Console so Postman can request tokens on your behalf:

1. Navigate to Prisma Console and log in
2. Click the 🧩 Integrations tab in the left sidebar
3. Under the "Published Applications" section, click New Application
4. Fill in your application details:
   • Name: Postman API Client
   • Description*: Brief description of your application *(Optional)
   • Redirect URI: https://oauth.pstmn.io/v1/callback
5. Click Continue
6. Important: Copy your Client ID and Client Secret immediately and store them securely

[!NOTE] The redirect URI https://oauth.pstmn.io/v1/callback is Postman's default callback URL when using the "Authorize using browser" option.

Configure Postman to request a token from Prisma Auth:

1. Open Postman and create a new HTTP request
2. Set the request method to POST
3. Set the URL to https://api.prisma.io/v1/projects
4. Navigate to the Authorization tab
5. Set Auth Type to OAuth 2.0
6. Under Configure New Token, enter the following values:

7. Click Get New Access Token
8. A browser window opens for you to complete the authorization flow
9. Return to Postman and click Use Token to attach it to your request
10. Verify that your new token appears under Current Token at the top of the Authorization tab

With authentication configured, you can now create a project:

1. In the request body, select raw and JSON format
2. Add the following JSON payload:

{
  "name": "My Postman Database",
  "region": "us-east-1"
}

3. Click Send

A successful response contains the new project's details.

Insomnia is an open-source API client with a clean interface for testing and debugging HTTP requests.

Before you begin, make sure you have:

• A Prisma Console account
• Insomnia installed

Register an OAuth2 application in Prisma Console so Insomnia can request tokens on your behalf:

1. Navigate to Prisma Console and log in
2. Click the 🧩 Integrations tab in the left sidebar
3. Under the "Published Applications" section, click New Application
4. Fill in your application details:
   • Name: Insomnia API Client
   • Description*: Brief description of your application *(Optional)
   • Redirect URI: https://app.insomnia.rest/oauth/redirect
5. Click Continue
6. Important: Copy your Client ID and Client Secret immediately and store them securely

[!NOTE] Insomnia uses https://app.insomnia.rest/oauth/redirect as the default OAuth callback URL for local authentication flows.

Configure Insomnia to request a token from Prisma Auth:

1. Open Insomnia and create a new HTTP request
2. Set the request method to POST
3. Set the URL to https://api.prisma.io/v1/projects
4. Navigate to the Auth tab
5. Set the authentication type to OAuth 2.0
6. Under Configuration, enter the following values:

7. Click Fetch Tokens
8. A browser window opens for you to complete the authorization flow
9. Return to Insomnia and verify that the access token has been retrieved
10. The token will be automatically attached to your requests

With authentication configured, you can now create a project:

1. Navigate to the Body tab and select JSON format
2. Add the following JSON payload:

{
  "name": "My Insomnia Database",
  "region": "us-east-1"
}

3. Click Send

A successful response contains the new project's details.

Yaak is a lightweight, open-source, and offline API client that works with Git.

Before you begin, make sure you have:

• A Prisma Console account
• Yaak installed

Register an OAuth2 application in Prisma Console so Yaak can request tokens on your behalf:

1. Navigate to Prisma Console and log in
2. Click the 🧩 Integrations tab in the left sidebar
3. Under the "Published Applications" section, click New Application
4. Fill in your application details:
   • Name: Yaak API Client
   • Description*: Brief description of your application *(Optional)
   • Redirect URI: https://devnull.yaak.app/callback
5. Click Continue
6. Important: Copy your Client ID and Client Secret immediately and store them securely

[!NOTE] The redirect URI can be any valid URL. Yaak intercepts the OAuth callback regardless of the redirect URI, as long as it matches what's registered with the provider.

Configure Yaak to request a token from Prisma Auth:

1. Open Yaak and create a new HTTP request
2. Set the request method to POST
3. Set the URL to https://api.prisma.io/v1/projects
4. Navigate to the Auth tab
5. Set the authentication type to OAuth 2.0
6. Enter the following values:

7. Click Get Token
8. A browser window opens for you to complete the authorization flow
9. Return to Yaak and verify that the access token has been retrieved
10. The token will be automatically attached to your requests

With authentication configured, you can now create a project:

1. Navigate to the Body tab and select JSON format
2. Add the following JSON payload:

{
  "name": "My Yaak Database",
  "region": "us-east-1"
}

3. Click Send

A successful response contains the new project's details.

• Authentication: Learn how to authenticate with the Prisma REST API using service tokens or OAuth 2.0
• Getting Started: Get started with the Prisma REST API by creating your first project and database
• Partner Integration: Build partner integrations that provision and transfer Prisma Postgres databases to users
• SDK: A TypeScript SDK for the Prisma Data Platform REST API. Use the simple client for direct API access, or the full SDK with built-in OAuth authentication and automatic token refresh