User Tools

Site Tools

You are here: start » amp » amp_api
amp:amp_api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
Last revision Both sides next revision
amp:amp_api [2020/03/18 09:41]
rsk [Example PHP Curl Script] 		amp:amp_api [2020/03/25 12:30]
rsk [Abuse Manager Pro API]
Line 1: Line 1:
 ====== Abuse Manager Pro API ====== ====== Abuse Manager Pro API ======
  
-<color #ffc90e>__The API is not released yet. It will be part of v3.4's release.__</color>+<color #ffc90e>__The API has been introduced in v3.4. Hence, it is only available & supported on v3.4 and above.__</color>
  
 This page explains the ways to interact with the Abuse Manager Pro API. This page explains the ways to interact with the Abuse Manager Pro API.
Line 12: Line 12:
   * Click on API credentials, click on Generate New API Credential button, select your admin user, select the API role created previously   * Click on API credentials, click on Generate New API Credential button, select your admin user, select the API role created previously
   * Copy the identifier only - we do not need the secret   * Copy the identifier only - we do not need the secret
-  * This identifier will be the API Key needed to authenticate with the API+  * This identifier will be the API_ID that needs to be passed in the header of your call to authenticate with the API
  
 +<code php>'API_ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'</code>
 ===== API URL / Endpoint ===== ===== API URL / Endpoint =====
  
Line 25: Line 26:
  
  
-===== Error Codes ===== 
  
-^ Code            ^ Description          ^ 
-| AMP001            | TBD        | 
-| AMP002            | TBD        | 
-| AMP003            | TBD        | 
-| AMP004            | TBD        | 
  
 ---- ----
Line 47: Line 42:
 | service_id | required - this is the WHMCS ID of the service that the abuse report will be created for | | service_id | required - this is the WHMCS ID of the service that the abuse report will be created for |
 | category | required - this is the category of abuse - can be any value e.g. 'Spam' or 'High I/O' or 'Hacking Attempts' etc. | | category | required - this is the category of abuse - can be any value e.g. 'Spam' or 'High I/O' or 'Hacking Attempts' etc. |
-| service_ip | optional - if not passed X |+| service_ip | optional - if not passed, the main dedicated IP of the service will be used - if service doesn't have a dedicated IP it will default to (No Dedicated IP) |
 | suspend_method | optional - defaults to nosuspend - available options are 'nosuspend', 'immediate', and 'timelimit' | | suspend_method | optional - defaults to nosuspend - available options are 'nosuspend', 'immediate', and 'timelimit' |
 | allow_unsuspend | optional - defaults to false - if you want to give the customer the option to self unsuspend set to true | | allow_unsuspend | optional - defaults to false - if you want to give the customer the option to self unsuspend set to true |
Line 57: Line 52:
  
  
 +
 +----
 +
 +===== Error Codes =====
 +
 +^ Code            ^ Description          ^
 +| AMP001            | Unauthorized - make sure you are passing a valid API_ID in the header        |
 +| AMP002            | Missing or Invalid Action - make sure you are passing a valid action        |
 +| AMP003            | Missing required parameters - make sure you are passing the required parameters for the action        |
  
 ---- ----
Line 77: Line 81:
             'category' => 'Spam',                                           // required - this is the category of abuse - can be any value e.g. 'Spam' or 'High I/O' or 'Hacking Attempts' etc.             'category' => 'Spam',                                           // required - this is the category of abuse - can be any value e.g. 'Spam' or 'High I/O' or 'Hacking Attempts' etc.
                          
-            'service_ip' => '1.2.3.4',                                      // optional - if not passed X+            'service_ip' => '1.2.3.4',                                      // optional - if not passed, the main dedicated IP of the service will be used - if service doesn't have a dedicated IP it will default to (No Dedicated IP)
             'suspend_method' => 'suspend',                                  // optional - defaults to nosuspend - available options are 'nosuspend', 'immediate', and 'timelimit'             'suspend_method' => 'suspend',                                  // optional - defaults to nosuspend - available options are 'nosuspend', 'immediate', and 'timelimit'
             'allow_unsuspend' => true,                                      // optional - defaults to false - if you want to give the customer the option to self unsuspend set to true             'allow_unsuspend' => true,                                      // optional - defaults to false - if you want to give the customer the option to self unsuspend set to true
amp/amp_api.txt · Last modified: 2020/03/25 12:30 by rsk

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki