Extend by order IDs

IPv4 type

The request allows to extend IP addresses by order IDs using all IP addresses from orders for proxy type IPv4.

POST /client/api/v1/{apiKey}/extend/order

Path parameters

Name
Type
Description

apiKey*

String

Your personal API key.

Request body

Name
Type
Description

proxyType*

String

Proxy type IPv4.

promoCode

String

Code of the promo code (can be obtained by another request).

orderIds*

List

Order IDs for extend (can be obtained by another request with IP addresses).

All addresses from orders will be extended.

All orderIds are separated by commas, for example ["11111", "22222"]

rentPeriodDays*

Number

Number of days in the rental period (can be obtained by another request).

Response

200: OK Success response
{
    "success": true,
    "proxyType": "IPv4",
    "rentPeriodDays": 30,
    "quantity": 1,
    "ipAddressIds": [
        "1111111111111111111"
    ],
    "balance": 0.65,
    "currency": "USD",
    "error": null,
    "promoCodeStatus": null
}
200: OK Success response with valid promo code
{
    "success": true,
    "proxyType": "IPv4",
    "rentPeriodDays": 30,
    "quantity": 1,
    "ipAddressIds": [
        "1111111111111111111"
    ],
    "balance": 0.65,
    "currency": "USD",
    "error": null,
    "promoCodeStatus": "VALID"
}
200: OK Success response with invalid promo code
{
    "success": true,
    "proxyType": "IPv4",
    "rentPeriodDays": 30,
    "quantity": 1,
    "ipAddressIds": [
        "1111111111111111111"
    ],
    "balance": 0.65,
    "currency": "USD",
    "error": null,
    "promoCodeStatus": "NO_VALID"
}
200: OK Error response
{
    "success": false,
    "proxyType": null,
    "rentPeriodDays": 0,
    "quantity": 0,
    "ipAddressIds": [],
    "balance": 0.65,
    "currency": "USD",
    "error": {
        "code": 29,
        "message": "Incorrect orderIds"
    },
    "promoCodeStatus": null
}

IPv6 type

The request allows to extend IP addresses by order IDs using all IP addresses from orders for proxy type IPv6.

POST /client/api/v1/{apiKey}/extend/order

Path parameters

Name
Type
Description

apiKey*

String

Your personal API key.

Request body

Name
Type
Description

proxyType*

String

Proxy type IPv6.

promoCode

String

Code of the promo code (can be obtained by another request).

orderIds*

List

Order IDs for extend (can be obtained by another request with IP addresses).

All addresses from orders will be extended.

All orderIds are separated by commas, for example ["11111", "22222"]

rentPeriodDays*

Number

Number of days in the rental period (can be obtained by another request).

Response

200: OK Success response
{
    "success": true,
    "proxyType": "IPv6",
    "rentPeriodDays": 30,
    "quantity": 1,
    "ipAddressIds": [
        "22222222222222222"
    ],
    "balance": 0.65,
    "currency": "USD",
    "error": null,
    "promoCodeStatus": null
}
200: OK Success response with valid promo code
{
    "success": true,
    "proxyType": "IPv6",
    "rentPeriodDays": 30,
    "quantity": 1,
    "ipAddressIds": [
        "22222222222222222"
    ],
    "balance": 0.65,
    "currency": "USD",
    "error": null,
    "promoCodeStatus": "VALID"
}
200: OK Success response with invalid promo code
{
    "success": true,
    "proxyType": "IPv6",
    "rentPeriodDays": 30,
    "quantity": 1,
    "ipAddressIds": [
        "22222222222222222"
    ],
    "balance": 0.65,
    "currency": "USD",
    "error": null,
    "promoCodeStatus": "NO_VALID"
}
200: OK Error response
{
    "success": false,
    "proxyType": null,
    "rentPeriodDays": 0,
    "quantity": 0,
    "ipAddressIds": [],
    "balance": 0.65,
    "currency": "USD",
    "error": {
        "code": 29,
        "message": "Incorrect orderIds"
    },
    "promoCodeStatus": null
}

Mobile type

The request allows to extend IP addresses by order IDs using all IP addresses from orders for proxy type MOBILE.

POST /client/api/v1/{apiKey}/extend/order

Path parameters

Name
Type
Description

apiKey*

String

Your personal API key.

Request body

Name
Type
Description

proxyType*

String

Proxy type MOBILE.

promoCode

String

Code of the promo code (can be obtained by another request).

orderIds*

List

Order IDs for extend (can be obtained by another request with IP addresses).

All addresses from orders will be extended.

All orderIds are separated by commas, for example ["11111", "22222"]

rentPeriodDays*

Number

Number of days in the rental period (can be obtained by another request).

Response

200: OK Success response
{
    "success": true,
    "proxyType": "MOBILE",
    "rentPeriodDays": 30,
    "quantity": 1,
    "ipAddressIds": [
        "333333333333333333"
    ],
    "balance": 0.65,
    "currency": "USD",
    "error": null,
    "promoCodeStatus": null
}
200: OK Success response with valid promo code
{
    "success": true,
    "proxyType": "MOBILE",
    "rentPeriodDays": 30,
    "quantity": 1,
    "ipAddressIds": [
        "333333333333333333"
    ],
    "balance": 0.65,
    "currency": "USD",
    "error": null,
    "promoCodeStatus": "VALID"
}
200: OK Success response with invalid promo code
{
    "success": true,
    "proxyType": "MOBILE",
    "rentPeriodDays": 30,
    "quantity": 1,
    "ipAddressIds": [
        "333333333333333333"
    ],
    "balance": 0.65,
    "currency": "USD",
    "error": null,
    "promoCodeStatus": "NO_VALID"
}
200: OK Error response
{
    "success": false,
    "proxyType": null,
    "rentPeriodDays": 0,
    "quantity": 0,
    "ipAddressIds": [],
    "balance": 0.65,
    "currency": "USD",
    "error": {
        "code": 29,
        "message": "Incorrect orderIds"
    },
    "promoCodeStatus": null
}

ISP type

The request allows to extend IP addresses by order IDs using all IP addresses from orders for proxy type ISP.

POST /client/api/v1/{apiKey}/extend/order

Path parameters

Name
Type
Description

apiKey*

String

Your personal API key.

Request body

Name
Type
Description

proxyType*

String

Proxy type ISP.

promoCode

String

Code of the promo code (can be obtained by another request).

orderIds*

List

Order IDs for extend (can be obtained by another request with IP addresses).

All addresses from orders will be extended.

All orderIds are separated by commas, for example ["11111", "22222"]

rentPeriodDays*

Number

Number of days in the rental period (can be obtained by another request).

Response

200: OK Success response
{
    "success": true,
    "proxyType": "ISP",
    "rentPeriodDays": 30,
    "quantity": 1,
    "ipAddressIds": [
        "444444444444444"
    ],
    "balance": 0.65,
    "currency": "USD",
    "error": null,
    "promoCodeStatus": null
}
200: OK Success response with valid promo code
{
    "success": true,
    "proxyType": "ISP",
    "rentPeriodDays": 30,
    "quantity": 1,
    "ipAddressIds": [
        "1111111111111111111"
    ],
    "balance": 0.65,
    "currency": "USD",
    "error": null,
    "promoCodeStatus": "VALID"
}
200: OK Success response with invalid promo code
{
    "success": true,
    "proxyType": "ISP",
    "rentPeriodDays": 30,
    "quantity": 1,
    "ipAddressIds": [
        "1111111111111111111"
    ],
    "balance": 0.65,
    "currency": "USD",
    "error": null,
    "promoCodeStatus": "NO_VALID"
}
200: OK Error response
{
    "success": false,
    "proxyType": null,
    "rentPeriodDays": 0,
    "quantity": 0,
    "ipAddressIds": [],
    "balance": 0.65,
    "currency": "USD",
    "error": {
        "code": 29,
        "message": "Incorrect orderIds"
    },
    "promoCodeStatus": null
}
PreviousExtend by IP addressesNextAuto-extend

Last updated