Controlling IP list Cloud

This API request has multiple functions accessible via same URL. Function that must be performed on the IP list must always be specified in the action parameter of each request.

Example Implementation
Download here.

Getting simple IP list

JSON request Object Properties:

• String action = list.
• Number licenseId - ID of a license to get IP list for.

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action.
• Number maxQuantity - (optional) max. number of IPs that can be added to this license.
• Array of String list - (optional) returned on success, contains list of IP's.
• Object error - (optional) returned on error, contains error message, indicates failure to execute action. Error object structure:
  • String message - text describing the error

Getting extended IP list

JSON request Object Properties:

• String action = list-full.
• Number licenseId - ID of a license to get IP list for.

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action.
• Number maxQuantity - (optional) max. number of IPs that can be added to this license.
• Array of Objects list - (optional) returned on success, contains list of IP's and assigned brands. Each IP object has following structure:
  • String ip - an IP address.
  • Number brandId - ID of brand assigned to IP.
• Object error - (optional) returned on error, contains error message, indicates failure to execute action. Error object structure:
  • String message - text describing the error

Adding a new IP

JSON request Object Properties:

• String action = add.
• Number licenseId - ID of a license to add IP to.
• String ip - IP you want to add.
• Number brandId - ID of a registered brand to assign.

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action.
• Object error - (optional) returned on error, contains error message, indicates failure to execute action. Error object structure:
  • String message - text describing the error

Updating an IP

JSON request Object Properties:

• String action = update.
• Number licenseId - ID of a license to update IP in.
• String ip - IP you want to update.
• String newIp - IP to update to (optional if brandId is specified).
• Number brandId - ID of a registered brand to assign (optional if newIp is specified).

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action.
• Object error - (optional) returned on error, contains error message, indicates failure to execute action. Error object structure:
  • String message - text describing the error

Deleting an existing IP

JSON request Object Properties:

• String action = delete.
• Number licenseId - ID of a license to delete IP from.
• String ip - IP you want to delete.

JSON response Object Properties:

• Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action.
• Object error - (optional) returned on error, contains error message, indicates failure to execute action. Error object structure:
  • String message - text describing the error

IP controlling example

Request Example:

POST /api/ipList HTTP/1.1
Host: site.pro
Authorization: Basic W0FQSSBVc2VybmFtZSBmcm9tIGJyYW5kXTpbQVBJIFBhc3N3b3JkIGZyb20gYnJhbmRd
Content-Type: application/json

{
   "action": "list-full",
   "licenseId": 123456789
}

Response Example:

HTTP/1.1 200 OK
Content-Type: application/json

{
   "ok": true,
   "list": [
      {
         "ip": "192.66.66.1",
         "brandId": 12345
      },
      {
         "ip": "192.66.66.2",
         "brandId": 12345
      }
   ]
}

Response With Error Example:

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
   "error": { "message": "some kind of error message" }
}