Перейти к основному содержимому

Лицензия API 1.7.0

Методы API для работы с разделом «Лицензия».

Базовый путь: https://{IP_контроллера}/api/v1. Версия описания API: 1.7.0.

Примеры используют placeholder-значения для паролей, token, UUID, адресов и секретов. Перед выполнением запроса замените их на значения вашего контроллера.

Методы раздела​

МетодПуть
GET/licence
POST/licence

GET /licence​

Раздел: Лицензия.

Возвращает текущий тип лицензии

Источник в Teamly

Назначение

URL запроса

Возвращает текущий тип лицензии

https://{IP_контроллера}/api/v1/licence

Параметры запроса:

Отсутствуют

Варианты ответа:

Code 200 (Returns current licence type) - удачное выполнение запроса

Пример:

{
  "licence": "BASIC"
}

Code 500 (Unexpected server error) - запрос не выполнен получено сообщение об ошибке

Параметры и ответы по OpenAPI
{
  "description": "Get current licence type",
  "responses": {
    "200": {
      "description": "Returns current licence type",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "licence"
            ],
            "properties": {
              "licence": {
                "type": "string",
                "enum": [
                  "BASIC",
                  "ENTERPRISE"
                ]
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI​

Сформированы по схеме контроллера; значения полей необходимо заменить.

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

curl -k -X GET "https://{IP_контроллера}/api/v1/licence" \
  -H "Authorization: Bearer <token>"

Пример ответа​

{
  "licence": "BASIC"
}

POST /licence​

Раздел: Лицензия.

Обновляет тип лицензии

Источник в Teamly

Назначение

URL запроса

Обновляет тип лицензии

https://{IP_контроллера}/api/v1/licence

Параметры запроса:

Название

Тип

Описание

licence*

object(body)

Тело запроса

BODY

Название

* - обязательный

Тип

Формат

Назначение

licence*

string

$binary

Файл лицензии в бинарном формате

Варианты ответа:

Code 200 (Successfully) - удачное выполнение запроса

{
  "success": false,
  "message": "string",
  "data": {}
}

Code 400 (Bad request parameters) - запрос не выполнен, неверно указаны параметры запроса

Code 500 (Unexpected server error) - запрос не выполнен получено сообщение об ошибке

Параметры и ответы по OpenAPI
{
  "description": "Upgrade licence",
  "requestBody": {
    "required": true,
    "content": {
      "multipart/form-data": {
        "schema": {
          "type": "object",
          "required": [
            "licence"
          ],
          "properties": {
            "licence": {
              "type": "string",
              "format": "binary"
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Licence successfully upgraded",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Bad licence file",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Server error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "success"
            ],
            "properties": {
              "success": {
                "type": "boolean",
                "example": false
              },
              "message": {
                "type": "string"
              },
              "data": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}

Примеры по OpenAPI​

Сформированы по схеме контроллера; значения полей необходимо заменить.

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

curl -k -X POST "https://{IP_контроллера}/api/v1/licence" \
  -H "Authorization: Bearer <token>" \
  --form 'licence=@/path/to/licence;type=application/octet-stream'

Пример ответа​

{
  "success": false,
  "message": "string",
  "data": {}
}