POST | Criar ou modificar uma requisição

  • 2 minuto(s) lido(s)
Prev Next

Cria uma nova requisição de certificado ou modifica uma requisição existente.

  • Endpoint: /api/certificate/request
  • Método: POST
  • Requisição: POST /api/certificate/request

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. As opções são: 1 = DV SSL - SSL de domínio, 2 = OV SSL - SSL de organização, e 3 = EV SSL - SSL estendido.
domain_type string Sim Tipo de domínio. As opções são: SING = Domínio único, MULT = Domínios múltiplo, e 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. As opções são: RSA e DSA.
encryption_key_size int Sim Tamanho da chave de criptografia. As opções são: 4096, 2048, e 1024.
certificate_algorithm string Sim Algoritmo de assinatura. As opções são: SHA256, SHA384, e 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/certificate/request \
  -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

Código de 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.
403 Forbidden Permissão negada.
404 Not Found Recurso não encontrado.
500 Internal Server Error Erro interno do servidor.