v1

latestOpenAPI 3.1.02026-07-2617028.7 KB

Endpoints

Generate custom back connect endpoints

Generate custom back connect endpoints for proxying for Residential subscription. If a default value is preset you don't need to actually include it in the request param query.

get/v2/endpoints-custom/back-connect

Query parameters

usernamestring

Provide username for authorization. This param is required.

passwordstring

Provide password for authorization. This param is required.

session_type'sticky' | 'random'

Choose what session type should be used. Choose sticky for sticky sessions or random for rotating sessions. Default is sticky.

session_timeinteger

Session time in minutes, range is 1-1440(inclusive). This param is required if param sessionType value is sticky. Default value is 10.

countrystring

Country Alpha2 code in lower case.

statestring

You can select state if country is USA(us). Provide full state name with underscore instead of a space. E.g. new_york.

citystring

Full city name in lowercase with underscore instead of a space. E.g. new_orleans.

output_format'protocol:auth@endpoint' | 'endpoint:auth' | 'auth@endpoint'

Output format type. Default is protocol:auth@endpoint.

countinteger

Count of routes that will be generated and returned. Min value is 1. Default is 10.

pageinteger

Page of the routes(pagination). Min value is 1. Default is 1.

response_format'json' | 'txt' | 'html'

What response type will be returned. Could be json, txt or html. Default is json.

line_break'\n' | '\r\n' | '\r' | '\t'

What line break will be used in response content. This is required if param responseType value is txt. Default is \n.

domainstring

What domain should be used for routes. Default is dedoco.com. ip is for using IP address instead of a domain.

ipstring

IP address to be used instead of a domain. This field is required if param domain value is ip. It always must contain port at the end e.g. 1.1.1.1:7000.

protocol'http' | 'https'

What protocol should be used. Default is http

Response

200

string[] required

Example response

[
  "http://user-smith-sessionduration-1:ao5nf23j4n@gate.visitxiangtan.com:10000"
]

All 17 operations