Skip to main content

Editing Proxy Folder

Editing proxy folder

Description: This method updates the name of the specified proxy folder. This is the only editable property.

Request parameters:

ParameterTypeFormatDefaultDescription
proxyFolderIdstringuuid(empty)The folder identifier (Required)
namestring(empty)The new folder name
workspaceIdintegerint64-1Workspace identifier. -1 means the default workspace.

Note:

The ID of the edited proxy list should be specified inside curly braces in the URL path.

Example request:

PUT
CURL:

curl 'http://localhost:8160/v1/proxy_folders/{proxyFolderId}?name=&workspaceId=' \
--request PUT \
--header 'Api-Token: YOUR_SECRET_TOKEN'

C#:

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("http://localhost:8160/v1/proxy_folders/{proxyFolderId}?name=&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/proxy_folders/{proxyFolderId}?name=&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 update.

Error Response (500):

{
"message": null
}