---
title: "How to Use the WP Umbrella Public API"
description: "This guide will help you set up and use the WP Umbrella API in Postman, making it easier to test and understand each API endpoint."
url: https://support.wp-umbrella.com/en/articles/3-how-to-use-the-wp-umbrella-public-api
collection: "Getting Started"
updated: 2026-10-12
language: en
---

# How to Use the WP Umbrella Public API

This guide will help you set up and use the WP Umbrella API in Postman, making it easier to test and understand each API endpoint.

## Overview

Postman is a powerful tool for testing APIs, and with the WP Umbrella API Postman Collection, you can quickly interact with all available endpoints. This guide walks you through the setup process, ensuring a smooth experience.

🕒 **Estimated Time to Complete:** 5–10 minutes  
✅ **Prerequisites:**

-   [**Postman**](https://www.postman.com/downloads/) – Installed on your computer (free to download).
    
-   [**WP Umbrella Postman .json Collection**](https://wp-umbrella.com/postman-public-api/) – Downloaded and imported.
    
-   **API Credentials** – An active access token (`accessToken`). If you don’t have one, contact your API administrator.
    

## Steps to Follow

### Step 1: Import the Postman Collection

1.  Open **Postman**.
    
2.  Click **Import** in the top left.
    
3.  Select **Upload Files** and choose the `.json` file you received.
    
4.  Once imported, the **WP Umbrella collection** will appear in your sidebar, with endpoints organized into folders like **Me, Projects, and Vulnerabilities**.
    

### Step 2: Set Up Environment Variables

Setting up variables in Postman makes it easier to reuse values without manual entry.

1.  Go to Environments in Postman and create a new environment.
    
2.  Add the following variables:
    
    -   `publicApiUrl` → Default: `https://public-api.wp-umbrella.com`
        
    -   `accessToken` → Your API access token
        
    -   `projectId` → The ID of the project you want to test
        
3.  Save the environment and **select it from the dropdown** in the top-right corner of Postman.
    

### Step 3: Configure Authentication

The WP Umbrella API uses **Bearer Token authentication**.

1.  Navigate to any endpoint in the collection.
    
2.  Click on the **Authorization** tab.
    
3.  Ensure the **Bearer Token** is selected.
    
4.  Confirm that `{{accessToken}}` is correctly referenced.
    

Once configured, Postman will automatically use this token for all API requests.

### Step 4: View Postman Documentation 📖

Postman includes built-in documentation for each API endpoint.

-   Click on the **collection folder** or any endpoint, then select the **Documentation** tab.
    
-   A **"View Complete Documentation"** link is also available at the bottom of the collection.
    

## Common Issues & Troubleshooting 🔧

❓ **Where to generate and get your access token.**  
To find your Public API simply go to your Profile page and click on ‘Generate my token’.

![](https://staticfiles.gleap.io/ghelparticle/GubUggXdywuEbSF6DXUaY3B61i2ybjor4ayK7ZqN7oaHtMF4wsCQ1kvPMcJw4rUDoU6l3Hx6hBD.gif)

❓ **I imported the collection, but I don’t see any endpoints.**  
Try re-importing the `.json` file. If the issue persists, restart Postman and check if the collection appears in the sidebar.

❓ **My API requests are failing due to authentication errors.**

-   Double-check that the **Bearer Token** is correctly referenced in the **Authorization** tab.
    
-   Ensure your **access token** is valid and has not expired.
    
-   Confirm that your selected **environment** contains the correct `accessToken` value.
    

## Final Thoughts 💡

That’s it! You’re now set up to explore the WP Umbrella API using Postman. If you have any questions or run into issues, don’t hesitate to contact our support team—we’re here to help! 😊

* * *

## Related Articles