Перейти к содержанию

stocks.php

Модуль управления серверами на складе: предоставление списков доступных серверов с фильтрацией по локациям и группам, а также детализированная информация о конкретном сервере.

Методы API

Метод Действие Описание
list получение списка серверов Возвращает список доступных серверов на складе с возможностью фильтрации по локации и группе.
show получение информации о сервере Возвращает детальную информацию о конкретном сервере по его идентификатору.

stocks/list

Возвращает список доступных серверов на складе с возможностью фильтрации по локации и группе.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action string Идентификатор метода: list
token string Токен авторизации. Обязателен для административных действий, опционален для публичного списка.
location string Фильтр по локации сервера (например, NL, DE). Если не указан или равен 'all', фильтруется по всем.
group string Фильтр по группе серверов.

Пример запроса

curl -s "https://invapi.hostkey.ru/stocks" -X POST \
--data "action=list"
Пример успешного ответа
{
  "result": "OK",
  "action": "list",
  "servers": [
    {
      "id": 1024,
      "name": "srv-nl-01",
      "location": "NL",
      "group": "dedicated",
      "status": "available",
      "price": {
        "EUR": 49.99,
        "USD": 54.99,
        "RUB": 4500.0
      },
      "specs": {
        "cpu": "Intel Xeon",
        "ram": 32,
        "disk": 1000
      },
      "created_at": "2024-01-15T10:30:00Z",
      "server_group": "Dedicated Server",
      "tags": [],
      "deployment_eta": null,
      "billing_plan": {}
    }
  ]
}
Примеры ошибок
{
  "code": -2,
  "message": "stocks/list: invalid token, logout",
  "description": "Неверный токен или отсутствие токена при требовании авторизации."
}

stocks/show

Возвращает детальную информацию о конкретном сервере по его идентификатору.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action string Идентификатор метода: show
token string Токен авторизации для доступа к API
id int Уникальный идентификатор сервера

Пример запроса

curl -s "https://invapi.hostkey.ru/stocks" -X POST \
--data "action=show" \
--data "id=VALUE"
Пример успешного ответа
{
  "result": "OK",
  "action": "show",
  "server_data": {
    "id": 1024,
    "name": "srv-nl-01",
    "location": "NL",
    "group": "dedicated",
    "status": "available",
    "price": {
      "EUR": 49.99,
      "USD": 54.99,
      "RUB": 4500.0
    },
    "specs": {
      "cpu": "Intel Xeon",
      "ram": 32,
      "disk": 1000
    },
    "created_at": "2024-01-15T10:30:00Z"
  }
}
Примеры ошибок
{
  "code": -2,
  "message": "stocks/show: invalid token, logout"
}

question_mark
Я могу вам чем-то помочь?
question_mark
ИИ Помощник ×