GET | Listar certificados

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

Recupera um ou mais certificados baseados em filtros específicos.

  • Endpoint: /api/v1/certificates
  • Método: GET
  • Requisição: GET /api/v1/certificates

Parâmetros da requisição

Parâmetro Tipo Obrigatório Descrição
code_certificate Int Não Código do certificado.
status_certificate Int Não Status do certificado. Valores: 1 = Válido, 2 = Revogado, 3 = Pendente de renovação, 4 = Expirado.
active Int Não Estado do certificado. Valores: 1 = Ativo, 0 = Inativo.
start_validity String Não Data de início da validade.
end_validity String Não Data de fim da validade.
origin_certificate String Não Origem do certificado. Valores: SCAN = Scan e descoberta, REQU = Requisição, IMPO = Importado manualmente.
type_certificate Int Não Tipo de certificado.
type_domain String Não Tipo de domínio.
organization Int Não Código de organização.
common_name String Não Nome comum do certificado.
san String Não Nomes alternativos do assunto (separados por vírgula).
tags String Não Tags de identificação (separadas por vírgula).
encryption String Não Algoritmo de criptografia.
encryption_key_size Int Não Tamanho da chave de criptografia.
algorithm_certified String Não Algoritmo de assinatura.
validity Int Não Período de validade do certificado em dias.
environments String Não Ambientes (separados por vírgula).
systems String Não Sistemas (separados por vírgula).
project String Não Nome do projeto.
ip_external String Não Endereço IP externo.
ip_hostname String Não IP ou hostname.
self_signed Int Não Indica se é auto assinado. Valores: 1 = true, 0 = false.
ca Int Não O código da CA responsável por assinar a requisição. O código é necessário caso o parâmetro self-signed seja falso.
responsible Int Não Código do usuário responsável.
offset Int Não Ponto de início da paginação.
limit Int Não Número de registros por página.

Exemplo utilizando cURL

curl -X GET "https://[segura_vault_url]/api/v1/certificates?organization=42&active=1&limit=10" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Resposta

{
  "status": 200,
  "message": "Certificates retrieved successfully",
  "error": false,
  "total": 3,
  "certificates": [
    {
      "code_certificate": 456,
      "status_certificate": "1 - Valid",
      "active": "1 - Active",
      "start_validity": "2024-01-15",
      "end_validity": "2025-01-15",
      "origin_certificate": "REQU - Request",
      "type_certificate": 2,
      "type_domain": "SING",
      "organization": 42,
      "common_name": "api.example.com",
      "encryption": "RSA",
      "encryption_key_size": 2048,
      "certificate_algorithm": "SHA256",
      "validity": 365
    }
    // Additional certificates will be listed here
  ]
}