Get resources list

Description

Retrieves all created resources list.

Request URL

Method: POST

https://example.com/api/v1.1/resources/list

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
format	string	"json"	No	Response data format By default – json
from_id	int	1	No	The first ID in the response. By default – 1
limit	int	1	No	Resources list limit. By default – 1000
groups	[]String	[ "group1", "group2" ]	No	List of access groups
groups_id	[]int	[ 0, 1 ]	No	List of access groups IDs

Request example

JSON

{
  "from_id": 1,
  "limit": 1,
  "token": "abcdefghijklmnqrstuvwxyz"
}

XML

<?xml version="1.0" encoding="UTF-8" ?>
<xml>
  <from_id>1</from_id>
  <limit>1</limit>
  <token>abcdefghijklmnqrstuvwxyz</token>
</xml>

Response example

JSON

{
  "data": [
    {
      "id": 1,
      "name": "Resource",
      "groups": [
        {
          "id": 1,
          "name": "subaccount"
        }
      ]
    }
  ],
  "error": 0,
  "error_text": "Successful operation",
  "next_from_id": 4,
  "total_count": 1
}

XML

<?xml version="1.0" encoding="UTF-8" ?>
<xml>
  <data>
    <id>1</id>
    <name>Resource</name>
    <groups>
      <id>1</id>
      <name>subaccount</name>
    </groups>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
  <next_from_id>4</next_from_id>
  <total_count>1</total_count>
</xml>

Response parameters

Parameter	Type	description
error	int	Error code
error_text	string	Error text
next_from_id	int	The index must be passed in the next request to receive another piece of data, until the result output contains 0 history lines
id	int	Resource ID
name	string	Resource name
total_count	int	Total resources count
groups	[]String	List of groups