Connect Qevlar to Proofpoint Protection Server (PPS) to investigate messages flagged at the email gateway, including quarantined emails with full header and attachment context. This page lists the permissions Qevlar requires and how to grant them.
Overview
Qevlar authenticates to Proofpoint PPS with a PPS account (username and password) sent as HTTP Basic authentication — no user sign-in per request. Access is governed by the account's role. The connector is read-only.
| API | Purpose | Auth |
|---|---|---|
| Proofpoint PPS REST API | Read quarantine and message data | HTTP Basic (account) |
The API base is your PPS API endpoint.
Connection details
Enter these values when configuring the connector in Qevlar:
| Field | Where to find it | Required |
|---|---|---|
| Base URL | Your PPS API endpoint, e.g. https://api.proofpoint.com | Yes |
| Username | A PPS account authorized for the REST API | Yes |
| Password | The account's password | Yes |
Required permissions
Use a PPS account assigned a role of type API with the pss and Quarantine managed modules selected. This grants the REST API read access to the quarantine and flagged message data (with header and attachment context) that Qevlar reads. No write permissions are required.
Setup
- Create or choose an account. In the PPS console, use a dedicated account authorized to use the REST API.
- Assign an API-type role. Ensure the account's role is type API with the pss and Quarantine managed modules selected, granting read access to quarantine and message data.
- Confirm the API endpoint. Note the PPS API base URL for your deployment.
- Configure the connector. In Qevlar, add the Proofpoint PPS connector and enter the connection details above.
Verify the connection
After saving, Qevlar runs a health check against the quarantine search endpoint. If it fails, check, in order:
- The Base URL is correct and reachable from Qevlar.
- The username and password are correct.
- The account's role is type API with the pss and Quarantine managed modules selected.
API reference
| Operation | HTTP | Endpoint |
|---|---|---|
| Quarantine search (health check) | GET | {baseUrl}/rest/v1/quarantine/search |
Authentication: HTTP Basic with the account username and password.