Introduction

Our API is designed to interact with the Field Effect MDR Portal ecosystem to provide clients the data they need pertaining to their operations at hand.

The API tries to embody RESTful practices wherever possible. The API communicates using JSON-encoded input & output for flexible object representation.

To gain access to our API documentation, please reach out to support@fieldeffect.com and include your public IP address. Your IP will be added to the documentation’s allowlist, and you will then be able to access it at https://services.fieldeffect.net/apidocs.

Common Use Cases

Our API Swagger interface can be used for various tasks, and the use cases below outline some common use cases for our API:

• Exporting Endpoint Data:
  • Generate a list of all endpoints, including their associated risk levels.
• Managing Partner Endpoints:
  • Export a list of all endpoints under a partner for all their clients.
• ARO Reporting:
  • Create reports for all AROs, or export specific AROs, based the on type or state (closed/resolved/open).
• SEAS Report Download:
  • Download all SEAS reports for individual clients or all clients under a partner.
• Client and Appliance Data:
  • Partners can download a list of all their clients, including details such as the type of appliance (physical or virtual) and the type of license assigned to each client.
• Export Vulnerability information: 
  • Export all of the vulnerability information for all endpoints within an organization.