Certificates Summary
Introduction
The Certificate Summary API provides a summary of certificate data based on a specific field.
Base URL
The base URL for all API requests is:
| Domain | URL |
|---|---|
| api.odin.io | api.odin.io/v1 |
The endpoint for host search is:
/certificates/summary/
Authentication
All requests to this API must include an authentication token in the headers. Use the following header for authentication:
X-API-Key: V8qb6HJIRKY7tVH0sou90I7YX3pCuqLQfRLmUzxpQbY=
Request Parameters
The API requires the following request parameter to be included in the request body:
https://api.odin.io/v1/certificates/summary/
Include the following parameters in the request body:
| Name | Description |
|---|---|
| field | Specifies the field to summarise the certificate data. This field can be any valid field in the certificate data. |
| limit | Specifies the maximum number of buckets to return in the summary. The value must be a positive integer. |
| query | Allows you to filter the certificate data based on specific attributes. The query parameter accepts a search query in the form of a string. |
Example Request
{
"field": "certificate.issuer.common_name",
"limit": 1,
"query": ""
}CURL
{
curl --location 'https://api.odin.io/v1/certificates/summary/' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: V8qb6HJIRKY7tVH0sou90I7YX3pCuqLQfRLmUzxpQbY=' \
--data '{
"field": "certificate.issuer.common_name",
"limit": 1,
"query": ""
}'
}This cURL command is structured to perform an HTTP POST request to https://api.odin.io/v1/certificates/count/. It includes the following headers:
'Accept: application/json': Specifies that the client expects a JSON response.
'Content-Type: application/json': Indicates that the content in the request body is in JSON format.
'X-API-Key: LlHUAbDjHza+y2ss98eNk1G85n1ctFwWUHX2SEbYZrE=': Provides the API key for authentication with the value 'LlHUAbDjHza+y2ss98eNk1G85n1ctFwWUHX2SEbYZrE='.
data '{ "field": "certificate.issuer.common_name", "limit": 1, "query": "" }': Sends a JSON payload in the request body. The payload specifies a summary request for the field 'certificate.issuer.common_name' with a limit of 1 result and an empty query.
Response Parameters
The response from the Odin Certificate Summary API will be in JSON format and include the following fields:
Example Response
{
"success": true,
"data": {
"doc_count_error_upper_bound": 4288690,
"sum_other_doc_count": 423189803,
"buckets": [
{
"doc_count": 948786932,
"key": "R3"
}
]
}
}| success | Indicates whether the API request was successful. |
| data | Contains the summary data. |
| doc_count_error_upper_bound | The approximate upper bound of the error on the document count. |
| sum_other_doc_count | The number of documents not included in the summary due to the limit. |
| buckets | An array of bucket objects representing the summarized data. |
| doc_count | The number of documents in the bucket. |
| key | The key representing the summarised field value. |
The response includes the summary information for the specified field. This example shows that there are 967,120,922 certificates with the issuer common name "R3".
