Using API Clients

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

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

First, you'll need to register an OAuth2 application in Prisma Console:

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. :::

2. Configure OAuth 2.0 in Postman

Now you'll set up authentication in Postman:

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 will open and have you 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

You should receive a successful response confirming your project creation.

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

First, you'll need to register an OAuth2 application in Prisma Console:

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. :::

2. Configure OAuth 2.0 in Insomnia

Now you'll set up authentication in Insomnia:

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 will open and have you 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

You should receive a successful response confirming your project creation.

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

First, you'll need to register an OAuth2 application in Prisma Console:

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. :::

2. Configure OAuth 2.0 in Yaak

Now you'll set up authentication in Yaak:

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 will open and have you 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

You should receive a successful response confirming your project creation.