Page tree

Generally, this section applies to both Armor Complete and Armor Anywhere users; however, review the table below to make sure the specific API call is compatible with your product. 

API callDescriptionProduct compatibility
Get AccountsThe Get Accounts API retrieves basic account information, particularly a list of products and services associated with the account (or accounts).
  • Armor Complete
  • Armor Anywhere
Update AccountThe Update Account API updates the billing address for your account.  
  • Armor Complete
  • Armor Anywhere
Get Account

The Get Account API retrieves basic account information. 

  • Armor Complete
  • Armor Anywhere
Get Account ContactsThe Get Account Contacts API retrieves a list of Armor support contacts for your account, such as the technical contact or billing contact.
  • Armor Complete
  • Armor Anywhere
Get Account UsageThe Get Account Usage API retrieves information for your servers, including server usage.
  • Armor Complete
  • Armor Anywhere
Get TagsThe Get Tags API retrieves tags based on entityType and entityID.
  • Armor Complete
  • Armor Anywhere
Create TagsThe Create Tags API adds a tag to a specified entityType and entityID. 
  • Armor Complete
  • Armor Anywhere
Delete TagsThe Delete Tags API deletes a specified tag for a given entityType and entityId. 
  • Armor Complete
  • Armor Anywhere
Get NotesThe Get Notes API retrieves a note for a specified entityType and entityID. 
  • Armor Complete
  • Armor Anywhere
Create NotesThe Create Notes API adds notes to a specified entityType and entityId.  
  • Armor Complete
  • Armor Anywhere
Delete NotesThe Deletes Notes API deletes notes from a specified entityType and entityId.  
  • Armor Complete
  • Armor Anywhere
Get InvoicesThe Get Invoices API retrieves invoices for your account, including paid and unpaid invoices; however, this API call will not retrieve deleted invoices. 
  • Armor Complete
  • Armor Anywhere
Get InvoiceThe Get Invoice API retrieves the invoice summary for a specified invoice.   
  • Armor Complete
  • Armor Anywhere
Get Invoice DetailThe Get Invoice Details API retrieves invoice export details for an invoice.   
  • Armor Complete
  • Armor Anywhere
Get Payment MethodsThe Get Payment Methods API retrieves information for the payment method for an account.   
  • Armor Complete
  • Armor Anywhere
Delete Payment MethodsThe Delete Payment Methods API deletes the payment method for an account.
  • Armor Complete
  • Armor Anywhere
Patch Payment MethodThe Patch Payment Method API configures the primary payment method for an account.    
  • Armor Complete
  • Armor Anywhere
Get Notification AlertsThe Get Notification Alerts API retrieves notification alerts for an account. 
  • Armor Complete
  • Armor Anywhere
Get Notification Alerts CountThe Get Notification Alerts Count API retrieves the number of alerts that have not been marked as 'read.'  
  • Armor Complete
  • Armor Anywhere
Mark Notification Alerts ReadThe Mark Notification Alerts Read API marks all notifications as 'read.'  
  • Armor Complete
  • Armor Anywhere
Mark Notification Alert ReadThe Mark Notification Alert Read API marks a specific notification alert as read.  
  • Armor Complete
  • Armor Anywhere
Get Product ListsThe Get Product Lists API retrieves any product lists that are associated to your account.  
  • Armor Complete
  • Armor Anywhere
Get Product ListThe Get Product List API retrieves a specific product list for your account.   
  • Armor Complete
  • Armor Anywhere
Get ProductsThe Get Products API retrieves a filtered list of products specific to a category within a given product list in your account.   
  • Armor Complete
  • Armor Anywhere
Get PermissionsThe Get Permissions API retrieves a list of all the permissions available in the account.   
  • Armor Complete
  • Armor Anywhere
Get RolesThe Get Roles API retrieves a list of all the roles on the account, including the associated permissions and assigned users.   
  • Armor Complete
  • Armor Anywhere
Create RoleThe Create Role API creates a role with a group of permissions.   
  • Armor Complete
  • Armor Anywhere
Delete RoleThe Delete Role API deletes a role by the specified ID.  
  • Armor Complete
  • Armor Anywhere
Get RoleThe Get Role API retrieves a role by the specified role ID. 
  • Armor Complete
  • Armor Anywhere
Update Role Name and PermissionsThe Update Role Name and Permissions API updates the name of the role and adds permissions to the role. 
  • Armor Complete
  • Armor Anywhere
Delete User From a RoleThe Delete User from a Role API removes a user from a role. 
  • Armor Complete
  • Armor Anywhere
Add User to a RoleThe Add User to a Role API adds a user to a role.   
  • Armor Complete
  • Armor Anywhere
Get SubscriptionsThe Get Subscriptions API retrieves subscriptions for the account. 
  • Armor Complete
  • Armor Anywhere
Cancel SubscriptionThe Cancel Subscription API cancels an active subscription. 
  • Armor Complete
  • Armor Anywhere
Get UsersThe Get Users API retrieves a list of users in your account.   
  • Armor Complete
  • Armor Anywhere
Invite UserThe Invite User API invites a new or existing user to an account.  
  • Armor Complete
  • Armor Anywhere
Get UserThe Get User API retrieves account information for a specified user.  
  • Armor Complete
  • Armor Anywhere
Update UserThe Update User API updates the profile details for a user. 
  • Armor Complete
  • Armor Anywhere
Reset User PasswordThe Reset User Password API resets a user's password.  
  • Armor Complete
  • Armor Anywhere
Get User Notification SettingsThe Get User Notification Settings API retrieves a user's notification setting.
  • Armor Complete
  • Armor Anywhere
Update User Notification SettingsThe Update User Notification Settings API updates the notifications settings for a user.  
  • Armor Complete
  • Armor Anywhere
Update a user status (enable or disable a user)The Update a user status API enables or disables a user account.
  • Armor Complete
  • Armor Anywhere
Resend User InviteThe Resend User Invite API resends the email invitation to the invited user. 
  • Armor Complete
  • Armor Anywhere
Update User Challenge PhraseThe Update User Challenge Phrase API updates the challenge phrase for a user account.  
  • Armor Complete
  • Armor Anywhere
Validate MFA Phone DeviceThe Validate MFA Phone Device API validates a phone number to use for Multi-Factor Authentication (MFA). 
  • Armor Complete
  • Armor Anywhere
Post Cloud ConnectionsThe Post Cloud Connections API returns basic information about existing cloud connections.
  • Armor Anywhere
Delete Cloud ConnectionsThe Delete Cloud Connections API removes a specified cloud connection from the Armor Management Portal (AMP); however, the cloud connection will remain in the internal database. 
  • Armor Anywhere
Get Cloud ConnectionsThe Get Cloud Connections API returns detailed information about a specified cloud connection.
  • Armor Anywhere
Get Cloud Connections (Status)The Get Cloud Connections (Status) API returns the status of cloud connections, specifically if the cloud connection is enabled or disabled, as well as the status of the corresponding services for each cloud connection
  • Armor Anywhere
Get Cloud Connections (Services Type)The Get Cloud Connections (Service Types) API returns information about the services associated with the cloud connection, such as CloudTrail Log Ingestion or EC2 Metadata and Orchestration
  • Armor Anywhere



In this topic



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