PureVPN APIs Documentation Explained for Developers

Illustration showing secure integration with PureVPN APIs using shield, lock, and coding symbols.

APIs are the backbone of modern software integration. They let you extend your app’s functionality without reinventing the wheel. PureVPN’s White Label APIs (PureWL) do exactly that; they let you embed VPN features directly into your own applications, giving users privacy, secure browsing, and even regional content access without having to leave your platform.

If you’re building a security product, a streaming tool, or even a mobile app that requires secure connectivity, PureVPN’s APIs can help you deliver those experiences seamlessly. In this blog, we’ll walk through how PureVPN’s APIs work, what each API family offers, and how you can use them to power your app.

Getting Started with PureVPN’s APIs

PureVPN APIs are REST-based and easy to consume. You interact with them over HTTPS at https://atomapi.com, and every call returns a JSON response. To get started, you’ll need:

  • A subscribed Partner Console account (console.purewl.com).
  • Your Secret Key, available inside the Partner Console.
  • An Access Token, which you’ll generate using the Secret Key.

Once authenticated, your app can fetch available servers, create VPN accounts, and point users to the fastest or streaming-optimized connection.

Think of it this way: PureVPN tells you where and how to connect; your app handles the actual VPN tunnel.

How PureVPN’s APIs Help?

Overview of PureVPN APIs for authentication, inventory access, and optimized streaming servers.

PureVPN White Label provides:

  • Authentication APIs – Securely connect your app to PureWL.
  • Inventory APIs – Fetch available countries and streaming services.
  • Optimized Streaming Servers – Special servers designed to bypass platform-specific blocks.

How Do PureVPN’s APIs Work?

Diagram of PureVPN APIs integration process including access token, server data, server selection, and VPN tunnel connection.

The flow is straightforward once you see it in action. Here’s the big picture:

  1. Get your Secret Key from the Partner Console.
  2. Request an Access Token — this will be attached to all subsequent calls.
  3. Fetch server data — countries, cities, protocols, or streaming services.
  4. Pick the fastest or most relevant server using the Optimized Server API.
  5. Dial the VPN tunnel using your own client logic (IPSec, IKEv2, OpenVPN, or WireGuard).
!
Note

PureVPN doesn’t expose APIs to connect or disconnect the tunnel. You’ll implement the actual VPN connection in your app, while PureWL provides the credentials and server metadata.

Once the connection is established, all traffic between your user and the internet flows securely, bypassing ISP monitoring or regional restrictions.

API Families You’ll Work With

PureVPN’s APIs are grouped into four main families. Let’s break down what each does and how you’ll use them.

1. Authentication APIs – Your First Step

Before you do anything, you’ll need to authenticate. The Authentication APIs give you the Access Token that unlocks all other endpoints.

  • Use case: Exchange your Secret Key for an accessToken and refreshToken.
  • Why it matters: Without tokens, your calls will be rejected. Tokens also control session expiry and refresh cycles.

Start Here: API Authentication

Get your accessToken & refreshToken to unlock every endpoint. Secure storage + auto-refresh recommended.

Open Authentication Guide →
Pro Tip

Always store tokens securely and implement auto-refresh to avoid session drops.

2. Inventory APIs – What Can Your Users Access?

Once you’re authenticated, the Inventory APIs tell you what’s available. They return the list of countries, cities, protocols, and streaming services your app can offer.

Get Subscribed Countries

Which countries can your users connect to? Use this API to explore all subscribed countries available for your app.

Explore Get Subscribed Countries APIs

Get Subscribed Cities

Narrow it down further to city-level servers.

Explore Get Subscribed Cities APIs

Get Subscribed Protocols

Discover available connection types (e.g., IKEv2, WireGuard).

Explore Get Subscribed Protocol APIs

Get Subscribed Channels

List streaming platforms (Netflix US, BBC iPlayer, etc.).

Explore Get Subscribed Channels APIs

Build Smarter with Inventory APIs

Use country, city, protocol, and service data to power dropdowns, automate region selection, and deliver a seamless user experience.

Explore Inventory APIs →

3. VPN Account Management – Handling User Credentials

Every VPN session needs credentials. The VPN Account Management (VAM) APIs let you create, update, and manage those accounts.

Create VPN Account

Quickly provision new VPN credentials to manage user access with security and ease.

Explore Create VPN Account APIs

Generate VPN Account

Fetch existing credentials or create new ones if none exist.

Explore Generate VPN Account APIs

Extend Expiry

Easily extend user subscriptions by adding extra days to ensure uninterrupted VPN access.

Explore Extend Expiry APIs

Renew Account

Renews an account close to expiry, ensuring uninterrupted service.

Explore Renew Account APIs

Enable Account

Quickly restore access for users by re-enabling previously disabled VPN accounts.

Explore Enable Account APIs

Disable Account

Temporarily suspends a VPN account without deleting it.

Explore Disable Account APIs

Delete Account

Permanently removes a VPN account from the system.

Explore Delete Account APIs

Change Password

Updates the login password for a VPN account.

Explore Change Password APIs

Get Status

Retrieves the current status and validity details of a VPN account.

Explore Get Status APIs

Update Subscription Type

Modifies a VPN account’s subscription level (e.g., trial, paid, or freemium).

Explore Update Subscription Type APIs

Total Control with VPN Account Management APIs

Manage how VPN credentials map to your user base—whether integrated with your own authentication system or used directly for full flexibility.

See All VPN Account Management APIs →

4. Optimized Server API – The Secret Sauce

Finally, once you know what users want (say, Netflix US or low-latency gaming in Europe), you’ll need the best server for the job. That’s where the Optimized Server API comes in.Get Optimized Server – Returns the fastest or most appropriate server based on country, city, protocol, device type, or streaming channel.

Find the Fastest Server

Use the Optimized Server API to always connect users to the best option for speed, location, and service.

Check Optimized Server API →

Your app then takes this server info and uses its own networking logic to establish the VPN tunnel. The result? Users always connect to the best available option without manual guesswork.

Best Practices for Developers

Developer best practices for working with PureVPN APIs including token refresh, server selection, fallback logic, UI feedback, and device awareness.
  • Automate token refresh – Avoid forcing users to log in again.
  • Smart server selection – Let the API pick the lowest-latency server for a smoother experience.
  • Fallback logic – If one server fails, retry with the next.
  • UI feedback – Show clear “Connected/Disconnected” states.
  • Device awareness – Always pass the correct device type (Android, iOS, Windows, macOS).

Final Thoughts

PureVPN’s APIs give you the building blocks to add secure, fast, and reliable VPN functionality to your own applications. From authentication to account management and server optimization, each API family plays a role in creating a seamless experience for your users.

And remember: PureVPN provides the infrastructure, but you control the connection. You’ll implement the VPN tunnel using your own client code while PureVPN tells you where to connect, with what credentials, and which server is best.

By combining your app’s UX with PureVPN’s global VPN backbone, you can offer privacy, streaming access, and performance that feels truly integrated.

Leave a Reply

Your email address will not be published. Required fields are marked *

Comment Form

Leave a Reply

Your email address will not be published. Required fields are marked *