Get nodes list

Description

Retrieves Altcraft service instance nodes list.

Request URL

Method: POST

https://example.com/api/v1.1/admin/nodes/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 node ID on the list By default –1
limit	int	100	No	Nodes list limit By default – 1000

Request example

JSON

{
  "token": "abcdefghijklmnqrstuvwxyz"
}

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
</xml>

Response example

JSON

{
    "data": [
        {
            "id": 1,
            "name": "new",
            "host": "localhost",
            "mode": "SSL"
        }
    ],
    "error": 0,
    "error_text": "Successful operation",
    "total_count": 1
}

XML

<xml>
    <data>
        <host>localhost</host>
        <id>1</id>
        <mode>SSL</mode>
        <name>new</name>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <total_count>1</total_count>
</xml>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
id	int	Node ID
name	string	Node name
host	string	Node IP:port
mode	string	"HTTPS" or "SSH" mode