Create list

This request allows you to create a list.

POST https://proxy-seller.com/api/v1/{YourApiKey}/resident/list/add

Example:

https://proxy-seller.com/api/v1/fj4948ffhg58gh843gh/resident/list/add

Path parameters:

Name	Value	Description
Authorization	<Your_API_Key>	Your personal API key

Request body:

Name	Type	Description
title	String	Name of the list you are creating
whitelist	String	IPs for authorization. Leave blank if you want to authorize with login credentials
geo	object	Add GEO data to your list (country, region, city, ISP)
country	String	Country selected from the GEO database
region	String	Region selected from the GEO database
city	String	City selected from the GEO database
isp	String	ISP selected from the GEO database
export	object	Here you specify the number of IPs in your list and the export type (port numbers and file format).
ports	Number	Number of IPs (maximum 1000)
ext	String	Type of export
rotation	Number	"rotation: '-1' for no rotation (Sticky), '0' for rotation per request, '1' to '3600' for time-based rotation in seconds

Response:

200: OK Success response

{
  "status": "success",
  "data": {
    "id": 561,
    "title": "US Washington Garfield FIRST-STEP",
    "login": "3c8aa1d4",
    "password": "AZT62Dx3",
    "whitelist": "127.0.0.1,192.168.0.1",
    "rotation": "-1 = sticky, 0 = rotation per request, 1..3600 time in seconds",
    "geo": {
      "country": "US",
      "region": "Washington",
      "city": "Garfield",
      "isp": "FIRST-STEP"
    },
    "export": {
      "ports": 10000,
      "ext": "txt"
    }
  },
  "errors": []
}

200: OK Error response Wrong API key

{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Error api key",
            "code": 503,
            "customData": null
        },
        {
            "message": "IP not allowed",
            "code": 503,
            "customData": null
        },
        {
            "message": "Request limit reached",
            "code": 503,
            "customData": null
        }
    ]
}

200: OK Error response Wrong authorization IP

{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "IP not allowed",
            "code": 503,
            "customData": null
        }
    ]
}

200: OK Error response Tarif not found

{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Tarif not found",
            "code": 0,
            "customData": null
        }
    ]
}

Responses with error in body request:

200: OK Error response Incorrect whitelist IP

{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Incorrect IP address 0.0.0.0 entered",
            "code": 409,
            "customData": null
        }
    ]
}

200: OK Error response IP already linked

{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "IP 127.0.0.1 already linked",
            "code": 0,
            "customData": null
        }
    ]
}

200: OK Error response Invalid country code

Same error may be in case with wrong "region", "city", "isp"!
{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Invalid country (region,  city, isp) ISO code",
            "code": 400,
            "customData": null
        },
        {
            "message": "Invalid country ISO code (400)",
            "code": 0,
            "customData": null
        }
    ]
}