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

Сертификаты API 1.7.0

Методы API для работы с разделом «Сертификаты».

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

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

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

МетодПуть
GET/certificate

GET /certificate​

Раздел: Сертификаты.

Возвращает корневой или серверный сертификат.

Параметры и ответы по OpenAPI
{
  "description": "Get CA root or server certificate",
  "parameters": [
    {
      "name": "type",
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "root",
          "server"
        ]
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Returned CA root or server certificate",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "certificate_file",
              "type"
            ],
            "properties": {
              "certificate_file": {
                "type": "string"
              },
              "type": {
                "type": "string",
                "enum": [
                  "root",
                  "server"
                ]
              }
            }
          }
        }
      }
    },
    "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 GET "https://{IP_контроллера}/api/v1/certificate" \
  -H "Authorization: Bearer <token>"

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

{
  "certificate_file": "string",
  "type": "root"
}