Skip to main content

Deleting Proxy

Description: This method deletes proxy from a list by specified ID.

Request parameters:

ParameterTypeFormatDefaultDescription
proxyIdstringuuid(empty)Unique identifier of the proxy (required).
workspaceIdintegerint64-1Workspace identifier. -1 means the default workspace.
note

The ID of the proxy to delete should be specified inside curly braces { } in the URL path.

Example request:

DELETE
CURL:

curl 'http://localhost:8160/v1/proxies/{proxyId}?workspaceId=' \
--request DELETE \
--header 'Api-Token: YOUR_SECRET_TOKEN'

C#:

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

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

Response API:

Response codeResult
200 OKSuccess
500 ErrorInternal Server Error

Success Response (200 OK):

No content returned on successful deletion.

Error Response (500):

{
"message": null
}