Differences

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

--- amp:amp_api [2020/03/19 06:39]
rsk [Generating your API ID For Authentication]
+++ amp:amp_api [2020/03/25 12:30] (current)
rsk [Abuse Manager Pro API]
@@ Line 1: / Line 1: @@
 ====== 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. Therefore, it is only available & supported on v3.4 and above.__</color>
 This page explains the ways to interact with the Abuse Manager Pro API.
@@ Line 26: / Line 26: @@
-===== Error Codes =====
-^ Code            ^ Description          ^
-| AMP001            | TBD        |
-| AMP002            | TBD        |
-| AMP003            | TBD        |
-| AMP004            | TBD        |
 ----
@@ Line 48: / Line 42: @@
 | 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. |
-| 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' |
 | allow_unsuspend | optional - defaults to false - if you want to give the customer the option to self unsuspend set to true |
@@ Line 58: / 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 78: / 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.
-            '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'
             'allow_unsuspend' => true,                                      // optional - defaults to false - if you want to give the customer the option to self unsuspend set to true

User Tools

Site Tools

Differences

Page Tools