Skip to main content

Deleting Proxy Folder with Contents

Description: This method deletes the specified proxy folder together with all proxies it contains. The proxyFolderId value must match an existing folder in the specified workspace.

warning

This operation deletes both the folder and every proxy inside it.

Request parameters:​

ParameterTypeFormatDefaultDescription
proxyFolderIdstringuuid(required)The identifier of the proxy folder to be deleted.
workspaceIdintegerint64-1Workspace identifier. -1 means the default workspace.

Example request:​

DELETE
CURL:

curl 'http://localhost:8160/v1/proxy_folders/123e4567-e89b-12d3-a456-426614174000/cascade?workspaceId=-1' \
--request DELETE \
--header 'Api-Token: YOUR_SECRET_TOKEN'

C#:

var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("http://localhost:8160/v1/proxy_folders/123e4567-e89b-12d3-a456-426614174000/cascade?workspaceId=-1"),
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/proxy_folders/123e4567-e89b-12d3-a456-426614174000/cascade?workspaceId=-1

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

Response API:​

Response codeResult
200 OKOK
401 UnauthorizedUnauthorized
403 ForbiddenForbidden
409 ConflictResource state conflict
422 Unprocessable ContentThe request cannot be processed
500 Internal Server ErrorInternal Server Error

Success Response (200 OK):

No response body.

Error Response:

{
"message": null
}