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

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

Prerequisites

Before you begin, make sure you have:

• A Prisma Console account
• Postman installed

1. Create an OAuth2 Application

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

2. Configure OAuth 2.0 in Postman

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

3. Make your first request

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

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

Prerequisites

Before you begin, make sure you have:

• A Prisma Console account
• Insomnia installed

1. Create an OAuth2 Application

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

2. Configure OAuth 2.0 in Insomnia

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

3. Make your first request

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

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

Prerequisites

Before you begin, make sure you have:

• A Prisma Console account
• Yaak installed

1. Create an OAuth2 Application

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

2. Configure OAuth 2.0 in Yaak

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

3. Make your first request

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.