Is an API available?
| Situation |
|
|---|---|
| Solution |
|
Where to get the Proofpoint Essentials API
The API is available across all stacks. As a reference point, you can get to the API documentation here:
Proofpoint Essentials Interface API v1
These are public facing URLs and do not require for you to be logged in to see.
What the API can do for you
The API allows admins to administrate the account without having to interact with the Proofpoint Essentials interface, i.e. the web UI.
In the API, these are items that can be done, but not limited to:
- Checking the domain settings: checking the individual domain through the domains tab.
- Check what features are enabled: checking the settings in the features tab
- Update individual user items like the approve sender list: going directly to the user profile and add in items to the approve list.
There are many other items that can be updated, changed, or removed with the API.
Coding
Proofpoint support does not offer any specific coding, or assistance with coding. All coding must be done by the customer side. We are unable to help with any custom coding, as the API can be used with any preferred coding method use to connect to our system.
A specific call does not work
In respect to coding, if a call gives a specific error, there are items that need to be adhered to.
Authentication
An Admin level account is required.
Organization admin - allowed only to work on the same account level
Strategic Partner/Channel Admin - allowed to work on the same domain as well as their customer accounts.
Base URL
The coding to connect requires a connection with the Base URL, along with the path: /api/v1. Make sure to appropriately use the base path of the stack of the domain you are working with is specifically on.
API calls are stack dependent, if you only have credentials for one stack i.e. US5 you will have to validate your credentials against that URL
Example for US1: https://us1.proofpointessentials.com/api/v1
Example for US5: https://us5.proofpointessentials.com/api/v1
Resources
Along with the base URL path, you can edit one of the resources:
- Organization
- Domain
- Users
- Endpoint
- Features
- Package
- Licensing
- Reporting
Method actions
As most APIs, the most common methods using the calls will be GET and PUT.
For full documentation and specific calls available to each endpoint, please visit any of these resources below. They are constantly updated with the latest information for particular API functionality:
https://us1.proofpointessentials.com/api/v1/docs/index.php
https://us2.proofpointessentials.com/api/v1/docs/index.php
https://us3.proofpointessentials.com/api/v1/docs/index.php
https://us4.proofpointessentials.com/api/v1/docs/index.php
https://us5.proofpointessentials.com/api/v1/docs/index.php
https://eu1.proofpointessentials.com/api/v1/docs/index.php