Create list
Updated:
Endpoint:
Path parameters
Name | Value | Description |
|---|---|---|
Authorization |
| 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 (Case is important) |
region | String | Region selected from the GEO database (Case is important) |
city | String | City selected from the GEO database (Case is important) |
isp | String | ISP selected from the GEO database (Case is important) |
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 |
Example
https://proxy-seller.com/personal/api/v2/fj4948ffhg58gh843gh/resident/list/add
{
"title": "myList",
"whitelist": "",
"geo": {
"country": "AD",
"region": "Andorra la Vella",
"city": "Andorra la Vella",
"isp": "Andorra Telecom, S.a.u."
},
"export": {
"ports": 1,
"ext": "csv"
},
"rotation": -1
}Response
{
"status": "success",
"data": {
"id": 21829782,
"title": "myList",
"login": "123123",
"password": "123123",
"whitelist": "",
"rotation": -1,
"geo": [
{
"country": "AD",
"region": "Andorra la Vella",
"city": "Andorra la Vella",
"isp": "Andorra Telecom, S.a.u."
}
],
"export": {
"ports": "1",
"ext": "csv"
}
},
"errors": []
}{
"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
}
]
}{
"status": "error",
"data": null,
"errors": [
{
"message": "IP not allowed",
"code": 503,
"customData": null
}
]
}{
"status": "error",
"data": null,
"errors": [
{
"message": "Tarif not found",
"code": 0,
"customData": null
}
]
}Responses with error in body request
{
"status": "error",
"data": null,
"errors": [
{
"message": "Incorrect IP address 0.0.0.0 entered",
"code": 409,
"customData": null
}
]
}{
"status": "error",
"data": null,
"errors": [
{
"message": "IP 127.0.0.1 already linked",
"code": 0,
"customData": null
}
]
}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
}
]
}