Knowledgebase
Is an API available?
Situation
  • Can I use a service to automate my account handling?
  • Is there a way to customize item settings without going through the interface?
  • Am I able to mass update customer settings?
Solution

This is a summary of the How - and if the solution is complex you might list the major steps/tasks out and break them into sections in the article:

  1. Where to get the Proofpoint Essentials API
  2. What the API can do for you.
  3. Coding
  4. A specific call does not work.

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:

API Overview

Proofpoint Essentials Interface API v1

These are public facing URLs and do not require for you to be logged in to see these.

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 the domain you are working with is specifically on.

Note: Example for US1: https://us1.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.

See theĀ specification page to see each resource and their associated methods. Some methods are not offered on a particular resource.

(0 vote(s))
This article was helpful
This article was not helpful

Comments (0)