Перейти к основному содержимому

Добавление нового прокси

Описание: Этот метод используется для добавления новой записи прокси с использованием заданных параметров конфигурации. Возвращает сгенерированный уникальный идентификатор.

Параметры запроса:

ParameterTypeFormatDefaultDescription
namestring(empty)Имя добавляемого прокси. Значение не может быть null или пустым.
proxyUrlstring(empty)URL‑адрес прокси. Значение должно быть корректным URL (не может быть null или пустым, например http://login:pass@host:port).
workspaceIdintegerint64-1Идентификатор рабочего пространства. -1 означает рабочее пространство по умолчанию.
folderIdstringuuid(empty)Необязательный идентификатор папки, с которой будет связан прокси. Может иметь значение null.
ipChangeUrlstring(empty)Необязательный URL для инициирования смены IP для прокси. По умолчанию — пустая строка, если не задан.

Пример запроса:

POST
CURL:

curl 'http://localhost:8160/v1/proxies/create?name=&proxyUri=&workspaceId=&folderId=&ipChangeUrl=' \
--request POST \
--header 'Api-Token: YOUR_SECRET_TOKEN'

C#:

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("http://localhost:8160/v1/proxies/create?name=&proxyUri=&workspaceId=&folderId=&ipChangeUrl="),
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/create?name=&proxyUri=&workspaceId=&folderId=&ipChangeUrl=

Дополнительно:
User-Agent: {-Profile.UserAgent-}
Api-Token: токен из UserArea2.

Ответ API:

Response codeResult
200 OKУспех
500 ErrorВнутренняя ошибка сервера

Успешный ответ (200 OK):

Возвращает массив, содержащий ID вновь созданного прокси:

[
"123e4567-e89b-12d3-a456-426614174000"
]

Ответ с ошибкой (500):

{
"message": null
}