SSL-сертификаты
Выпуск SSL-сертификатов
- Получение списка SSL-сертификатов
- Загрузка нового сертификата.
- Заказ выпуска нового сертификата.
- Поиск SSL-сертификатов
- Получить информацию о сертификате.
- Обновить информацию об сертификате.
- Удалить сертификат
- Скачать сертификат
- Продлить сертификат
Получение списка SSL-сертификатов
URL: /api/v1/certificates/
Метод: GET
Результат: JSON
Параметры запроса
Необязательные параметры:
offset:int– Индекс первой строки выборки, начиная с 0limit:int– Количество элементов в выборке в диапазоне от 1 до 100
Коды ответов
| Код | Описание |
|---|---|
| 200 | Успешный запрос |
Возвращаемое значение
count:int– Количество элементовentities– Список сертификатовid:int– Идентификатор сертификата.name:str– Имя сертификата.domains:Список str– Список доменов для которых выпущен сертификат.publisher:str– Издатель сертификата.state:str– Состояние сертификата.created:datetime– Дата создание сертификата.updated:datetime– Дата последнего обновления сертификата.not_after:datetime– Дата после которой сертификат недействителен.not_before:datetime– Дата с которой сертификат действителен.
Пример запроса
curl --request GET 'https://api-ms.netangels.ru/api/v1/certificates/' \
--header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"
Загрузка нового сертификата.
URL: /api/v1/certificates/
Метод: POST
Результат: JSON
Параметры тела запроса
Обязательные параметры:
certificate:str– Контент сертификата (в base64)private_key:str– Контент приватного ключа (в base64)
Необязательные параметры:
name:str– Название сертификата
Коды ответов
| Код | Описание |
|---|---|
| 201 | Успешное создание |
| 400 | Данные в запросе имеют неверный формат или отсутствуют обязательные параметры |
Возвращаемое значение
Сертификат
id:int– Идентификатор сертификата.name:str– Имя сертификата.domains:Список str– Список доменов для которых выпущен сертификат.publisher:str– Издатель сертификата.state:str– Состояние сертификата.created:datetime– Дата создание сертификата.updated:datetime– Дата последнего обновления сертификата.not_after:datetime– Дата после которой сертификат недействителен.not_before:datetime– Дата с которой сертификат действителен.
Пример запроса
curl --request POST 'https://api-ms.netangels.ru/api/v1/certificates/' \
--header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
--header "Content-Type: application/json" \
--data '{
"certificate": "bmV0YW5nZWxz",
"private_key": "bmV0YW5nZWxzIGtleQ=="
}'
Заказ выпуска нового сертификата.
URL: /api/v1/certificates/order/
Метод: POST
Результат: JSON
Для заказа нового сертификата мы предоставляем вам двух издателей: LeaderSSL и Let’s Encrypt.
Параметры тела запроса
Обязательные параметры:
domains:Список str– Список доменов для выпускаемого сертификата
Необязательные параметры:
publisher:str– Издатель:LeaderSSL– Платный сертификат от SectigoLetsEncrypt– Бесплатный сертификат от Let’s EncryptAlphaSSL– Платный сертификат AlphaSSL от GlobalSign
extension_period:int– Срок действия:1– 1 год
Коды ответов
| Код | Описание |
|---|---|
| 201 | Успешное создание |
| 400 | Данные в запросе имеют неверный формат или отсутствуют обязательные параметры |
Возвращаемое значение
Сертификат
id:int– Идентификатор сертификата.name:str– Имя сертификата.domains:Список str– Список доменов для которых выпущен сертификат.publisher:str– Издатель сертификата.state:str– Состояние сертификата.created:datetime– Дата создание сертификата.updated:datetime– Дата последнего обновления сертификата.not_after:datetime– Дата после которой сертификат недействителен.not_before:datetime– Дата с которой сертификат действителен.
Пример запроса
curl --request POST 'https://api-ms.netangels.ru/api/v1/certificates/order/' \
--header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
--header "Content-Type: application/json" \
--data '{
"domains": ["example.com"],
"publisher": "LetsEncrypt"
}'
Поиск SSL-сертификатов
URL: /api/v1/certificates/find/
Метод: GET
Результат: JSON
Параметры тела запроса
Обязательные параметры:
domains:Список str– Список доменов для выпускаемого сертификата
Необязательные параметры:
is_issued_only:bool– Искать только действующий сертификат
Коды ответов
| Код | Описание |
|---|---|
| 200 | Успешный запрос |
| 400 | Данные в запросе имеют неверный формат или отсутствуют обязательные параметры |
Возвращаемое значение
entities– Список сертификатовid:int– Идентификатор сертификата.name:str– Имя сертификата.domains:Список str– Список доменов для которых выпущен сертификат.publisher:str– Издатель сертификата.state:str– Состояние сертификата.created:datetime– Дата создание сертификата.updated:datetime– Дата последнего обновления сертификата.not_after:datetime– Дата после которой сертификат недействителен.not_before:datetime– Дата с которой сертификат действителен.
Пример запроса
curl --request GET 'https://api-ms.netangels.ru/api/v1/certificates/find/' \
--header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"
Получить информацию о сертификате.
URL: /api/v1/certificates/{id}/
Метод: GET
Результат: JSON
Параметры запроса
Необязательные параметры:
id:str– ID сертификата
Коды ответов
| Код | Описание |
|---|---|
| 200 | Успешный запрос |
| 404 | Сертификат не найден |
Возвращаемое значение
Сертификат
id:int– Идентификатор сертификата.name:str– Имя сертификата.domains:Список str– Список доменов для которых выпущен сертификат.publisher:str– Издатель сертификата.state:str– Состояние сертификата.created:datetime– Дата создание сертификата.updated:datetime– Дата последнего обновления сертификата.not_after:datetime– Дата после которой сертификат недействителен.not_before:datetime– Дата с которой сертификат действителен.
Пример запроса
curl --request GET 'https://api-ms.netangels.ru/api/v1/certificates/{id}/' \
--header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"
Обновить информацию об сертификате.
URL: /api/v1/certificates/{id}/
Метод: PUT
Результат: JSON
Параметры запроса
Необязательные параметры:
id:str– ID сертификата
Параметры тела запроса
Необязательные параметры:
name:str– Название сертификатаextension_period:int– Срок действия:1– 1 год
is_renewal:bool– Автоматический перевыпускcertificate:str– Контент сертификата (в base64)private_key:str– Контент приватного ключа (в base64)
Коды ответов
| Код | Описание |
|---|---|
| 200 | Успешный запрос |
| 400 | Данные в запросе имеют неверный формат или отсутствуют обязательные параметры |
| 404 | Сертификат не найден |
Возвращаемое значение
Сертификат
id:int– Идентификатор сертификата.name:str– Имя сертификата.domains:Список str– Список доменов для которых выпущен сертификат.publisher:str– Издатель сертификата.state:str– Состояние сертификата.created:datetime– Дата создание сертификата.updated:datetime– Дата последнего обновления сертификата.not_after:datetime– Дата после которой сертификат недействителен.not_before:datetime– Дата с которой сертификат действителен.
Пример запроса
curl --request PUT 'https://api-ms.netangels.ru/api/v1/certificates/{id}/' \
--header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
--header "Content-Type: application/json" \
--data '{
"extension_period": 1,
"is_renewal": true,
"certificate": "bmV0YW5nZWxz",
"private_key": "bmV0YW5nZWxzIGtleQ=="
}'
Удалить сертификат
URL: /api/v1/certificates/{id}/
Метод: DELETE
Параметры запроса
Необязательные параметры:
id:str– ID сертификата
Коды ответов
| Код | Описание |
|---|---|
| 200 | Успешный запрос |
| 404 | Сертификат не найден |
Пример запроса
curl --request DELETE 'https://api-ms.netangels.ru/api/v1/certificates/{id}/' \
--header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"
Скачать сертификат
URL: /api/v1/certificates/{id}/download/
Метод: GET
Параметры запроса
Необязательные параметры:
id:str– ID сертификата
Параметры тела запроса
Необязательные параметры:
name:str– Имя файлаtype:str– Тип файла:tartar.gztar.bz2tar.xzzip
Коды ответов
| Код | Описание |
|---|---|
| 200 | Успешный запрос |
| 404 | Сертификат не найден |
| 400 | Данные в запросе имеют неверный формат или отсутствуют обязательные параметры |
Пример запроса
curl --request GET 'https://api-ms.netangels.ru/api/v1/certificates/{id}/download/' \
--header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"
Продлить сертификат
URL: /api/v1/certificates/{id}/renewal/
Метод: PUT
Результат: JSON
Параметры запроса
Необязательные параметры:
id:str– ID сертификата
Коды ответов
| Код | Описание |
|---|---|
| 200 | Успешный запрос |
| 404 | Сертификат не найден |
Возвращаемое значение
Сертификат
id:int– Идентификатор сертификата.name:str– Имя сертификата.domains:Список str– Список доменов для которых выпущен сертификат.publisher:str– Издатель сертификата.state:str– Состояние сертификата.created:datetime– Дата создание сертификата.updated:datetime– Дата последнего обновления сертификата.not_after:datetime– Дата после которой сертификат недействителен.not_before:datetime– Дата с которой сертификат действителен.
Пример запроса
curl --request PUT 'https://api-ms.netangels.ru/api/v1/certificates/{id}/renewal/' \
--header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"