Skip to main content

Getting Proxy List with Parameters

Description: This method provides functionality for filtering, sorting, and paginating proxies. It is used to utilize the available parameters to customize the output. If parameters are not specified, the response will return the default page with results in standard order.

Request parameters:

ParameterTypeFormatDefaultDescription
workspaceIdintegerint64-1Workspace identifier. -1 means the default workspace.
startintegerint320Starting index for the list of proxies to retrieve.
totalintegerint321000Maximum number of proxies to retrieve.
folderIdstringuuid(empty)Optional folder ID for filtering proxies. Pass null to ignore this filter.
idstringuuid(empty)Ooptional proxy ID to filter. Pass null to ignore this filter.
namestring(empty)Optional name for filtering proxies. Pass null to ignore this filter.
sortingstring(empty)Ooptional sorting string to determine the order of the returned proxies. Pass null to ignore this filter.

Example request:

GET
CURL:

curl 'http://localhost:8160/v1/proxies?workspaceId=&start=&total=&folderId=&id=&name=&sorting=' \
--header 'Api-Token: YOUR_SECRET_TOKEN'

C#:

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("http://localhost:8160/v1/proxies?workspaceId=&start=&total=&folderId=&id=&name=&sorting="),
Headers =
{
{ "Api-Token", "YOUR_SECRET_TOKEN" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}

Cube:

http://localhost:8160/v1/proxies?workspaceId=&start=&total=&folderId=&id=&name=&sorting=

Additionally:
User-Agent: {-Profile.UserAgent-}
Api-Token: Token from UserArea2.

Response API:

Response codeResult
200 OKSuccess
500 ErrorInternal Server Error

Success Response (200 OK):

{
"totalCount": 1,
"items": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"folderId": "123e4567-e89b-12d3-a456-426614174000",
"name": null,
"proxyUri": null,
"checkStatus": "Unknown",
"checkStatusLastUpdateTime": null,
"ipChangeUrl": null
}
]
}

Error Response (500):

{
"message": null
}