Lista certificados baseados em filtros específicos.
- Endpoint:
/api/certificate/list
- Método:
GET
- Requisição:
GET /api/certificate/list
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. As opções são: 1 = Válido, 2 = Revogado, 3 = Pendente de renovação, e 4 = Expirado. |
active |
int |
Não |
Estado do certificado. As opções são: 1 = Ativo e 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. As opções são: SCAN = Scan e descoberta, REQU = Requisição, e 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. As opções são: 1 = true e 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 esteja definido como false. |
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/certificate/list" \
-H "Authorization: Bearer YOUR_API_TOKEN"
Resposta
{
"code": 200,
"response": {
"status": 200,
"message": "1001: OK",
"error": false,
"error_code": 0,
"detail": "",
"mensagem": "1001: OK",
"erro": false,
"cod_erro": 0
},
"tenant": "Segura",
"data": [
{
"certificate_code": "1",
"ca": "teste-api",
"common_name": "teste-api",
"san": null,
"organization": "teste-api",
"start_validity": "2024-10-02 12:29:46",
"end_validity": "2025-10-02 12:29:46",
"validity": "6",
"encryption": "RSA",
"encryption_key_size": "2048",
"status_certificate": "Valid",
"active": "Yes",
"tags": null,
"origin_certificate": "IMPO",
"environments": null,
"systems": null,
"project": null,
"responsible": null,
"description": null
}
// Additional certificates will be listed here
]
}
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. |