Getting Proxy Folder List

Please read the Material Usage Rules on this site.

Description: This method is used to get the list of proxy folders. It supports filtering, sorting, and pagination in returned results. Optional query parameters can be used to refine the result set. If parameters are not specified, the method returns the first page of proxy folders in the default sorting order.

Request parameters:

Parameter	Type	Format	Default	Description
workspaceId	integer	int64	-1	Workspace identifier. -1 means the default workspace.
start	integer	int32	(empty)	Index of the first folder to return (zero-based).
total	integer	int32	(empty)	Maximum number of results to return.
id	string	uuid	(empty)	Filter by certain folder identifier (optional).
name	string		(empty)	Filter by folder name (optional).
sorting	string		(empty)	Result sorting condition (optional).
location	string		(empty)	Proxy type filter (Local or Cloud).

Example request:

GET
CURL:

curl 'http://localhost:8160/v1/proxy_folders?workspaceId=-1&start=0&total=1000&id=123e4567-e89b-12d3-a456-426614174000&name=ApiEntity&sorting=name%20ASC&location=Local' \
  --header 'Api-Token: YOUR_SECRET_TOKEN'

C#:

using System.Text;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("http://localhost:8160/v1/proxy_folders?workspaceId=-1&start=0&total=1000&id=123e4567-e89b-12d3-a456-426614174000&name=ApiEntity&sorting=name%20ASC&location=Local"),
    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?workspaceId=&start=&total=&id=&name=&sorting=&=

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

Response API:

Response code	Result
200 OK	OK
401 Unauthorized	Unauthorized
403 Forbidden	Forbidden
500 Internal Server Error	Internal Server Error

Success Response (200 OK):

{
  "totalCount": 1,
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Sample Name",
      "location": "string",
      "quantity": 1
    }
  ]
}

Error Response (500):

{
  "message": null
}

---