Page tree


In This Document 



Have a suggestion for the Armor Knowledge Base? Send a message to kb@armor.com.




Overview

Armor offers a RESTful HTTP service called the Armor API. This API system allows you to fully access the Armor Management Portal (AMP) via JSON data formats, which allows you to programmatically manage elements of your AMP account.

This guide applies to both Armor Complete and Armor Anywhere users; however, you should review the beginning of each section to verify product compatibility.


Access the Armor API

To learn how to access the Armor API, see Log into Armor API


Access the interactive Armor API

The interactive Armor API tool, powered by Swagger, is a cloud-based tool used to build, deploy, and document APIs. You can use this tool to test, review, and implement API calls.  

To learn more, see The interactive Armor API.


Review Armor API calls

The Armor API is divided into the following sections: 

API sectionDescriptionProduct compatibility
Authentication

View API information for:

  • Logging into the Armor API
  • Password recovery
  • API keys
  • Armor Complete
  • Armor Anywhere
Infrastructure

View API information for:

  • Workloads
  • Virtual machines
  • Armor Complete
Network Services

View API information for:

  • NATs / IP addresses
  • Firewall rules
  • SSL/VPN
  • L2L tunnels
  • Armor Complete
Security

View API information for:

  • Patching
  • Log & Data Management
  • Malware Protection
  • Vulnerability scans
  • Dynamic Threat Blocking
  • Armor Complete
  • Armor Anywhere
Support

View API information for:

  • Support tickets
  • Armor Complete
  • Armor Anywhere
Account Management

View API information for:

  • Invoices
  • Payment methods
  • Roles and permissions
  • Notification settings
  • User management
  • Armor Complete
  • Armor Anywhere
Keys

View API information to: 

  • Create, rename, delete, and view API keys
  • Armor Complete
  • Armor Anywhere
Account Primary Billing

View API information to:

  • View and change the account primary billing user
  • Armor Complete
  • Armor Anywhere
Security Analytics

View API information for:

  • Your account's health scores
  • Armor security resources
  • Armor Complete
  • Armor Anywhere
Security Incidents

View API information to: 

  • Retrieve open or closed security incidents
  • Armor Complete
  • Armor Anywhere
Security Services

View API information for: 

  • IP Reputation Management (IPRM) / Dynamic Threat Blocking
  • Armor Complete
  • Armor Anywhere
Utilization

View API information for:

  • Your account usage
  • Armor Anywhere



Learn about Armor API basics 

To learn about request methods and object-type definitions, see Learn about Armor API