Cria uma nova requisição de certificado ou modifica uma requisição existente.
- Endpoint:
POST /api/v1/certificates/requests
- Método:
POST
- Requisição:
POST /api/v1/certificates/requests
Parâmetros da requisição
Parâmetro |
Tipo |
Obrigatório |
Descrição |
code_request |
Int |
Não |
Código de uma requisição existente. Caso não seja inserido, uma nova requisição será criada. |
certificate_type |
Int |
Não |
Tipo do certificado. Valores: 1 = DV SSL - SSL de domínio, 2 = OV SSL - SSL de organização, 3 = EV SSL - SSL estendido. |
domain_type |
String |
Sim |
Tipo de domínio. Valores: SIGN = Domínio único, MULT - Domínios múltiplos, WILD - Curinga. |
organization |
Int |
Sim |
Código da organização. Precisa ser uma organização válida cadastrada na Segura®. |
common_name |
String |
Sim |
Nome comum do certificado. |
san |
Array |
Não |
Nomes alternativos do assunto. Caso não seja inserido será preenchido com common_name . |
tags |
Array |
Não |
Tags de identificação do certificado. Novas tags serão criadas se ainda não existirem. |
encryption |
String |
Sim |
Algoritmo de criptografia. Valores: RSA , DSA . |
encryption_key_size |
Int |
Sim |
Tamanho da chave de criptografia. Valores: 4096 , 2048 , 1024 . |
certificate_algorithm |
String |
Sim |
Algoritmo de assinatura. Valores: SHA256 , SHA384 , SHA512 . Se a criptografia for DSA, apenas SHA256 é permitido. |
validity |
Int |
Sim |
Período de validade do certificado em dias. |
key_password |
String |
Não |
Senha da chave do certificado. |
senha_revogacao |
String |
Não |
Senha de revogação do certificado. |
environments |
Array |
Não |
Ambientes do certificado. Novos ambientes serão criados se ainda não existirem. |
systems |
Array |
Não |
Sistemas do certificado. Novos sistemas serão criados se ainda não existirem. |
project |
String |
Não |
Nome do projeto. |
external_ip |
String |
Não |
IP externo do certificado. |
hostname_ip |
String |
Não |
IP ou hostname do certificado. |
justification |
String |
Não |
Justificativa da solicitação (máx. 1024 caracteres). |
responsible |
Int |
Não |
Código do usuário responsável. Deve ser um usuário registrado no Segura. |
description |
String |
Não |
Descrição da solicitação (máx. 512 caracteres). |
Exemplo utilizando cURL
curl -X POST https://[segura_vault_url]/api/v1/certificates/requests \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"certificate_type": 2,
"domain_type": "SING",
"organization": 42,
"common_name": "api.example.com",
"encryption": "RSA",
"encryption_key_size": 2048,
"certificate_algorithm": "SHA256",
"validity": 365,
"justification": "Needed for new API service",
"description": "Certificate for public API endpoints"
}'
Resposta
{
"status": 200,
"message": "Request created successfully",
"error": false,
"code_request": 123,
"type_certificate": 2,
"type_domain": "SING",
"organization": 42,
"common_name": "api.example.com",
"encryption": "RSA",
"encryption_key_size": 2048,
"certificate_algorithm": "SHA256",
"validity": 365,
"justification": "Needed for new API service",
"description": "Certificate for public API endpoints"
}
Respostas de erro
Status HTTP |
Descrição |
400 Bad Request |
Parâmetros inválidos fornecidos (campos obrigatórios ausentes ou formato inválido). |
401 Unauthorized |
Acesso não autorizado. |
404 Not Found |
Certificado com o ID especificado não foi encontrado. |
500 Internal Server Error |
Erro do lado do servidor ocorreu durante o processamento do certificado. |