Search download

post https://api.spyse.com/v4/data/certificate/search/download

Initiates the creation of the file with data about SSL certificates that matched the search query. When the file is created, it will be available for download. On the successful call, returns the unique identifier that represents the file creation process. The file creation is an asynchronous process, because the amount of data that should be exported to the file and the export duration is hard to predict. The call to this endpoint just initiates the file creation. To check the file status and get the download link, send a GET request to the /v4/data/account/downloads/ API endpoint with the identifier returned by this endpoint. The number of rows available for download is determined by the subscription plan.

Options for search params:

Search parameter	Operator	Value
issued_for_domain	`eq`	Domain the certificate is issued for. `string`
issued_for_ip	`eq`	IP address the certificate is issued for. `string`
issuer_country	`eq`, `exists`, `not_exists`	Country ISO code the issuer organization is registered in. `string`
issuer_org	`eq`, `contains`, `exists`, `not_exists`	Issuer organization name. `string`
issuer_common_name	`eq`, `contains`, `exists`, `not_exists`	Issuer common name. Example: “DigiCert SHA2 Secure Server CA”. `string`
issuer_email	`eq`, `contains`, `exists`, `not_exists`	Issuer email. `string`
subject_country	`eq`, `exists`, `not_exists`	Country ISO code the subject organization is registered in. `string`
subject_org	`eq`, `contains`, `exists`, `not_exists`	Subject organization name. `string`
subject_common_name	`eq`, `contains`, `exists`, `not_exists`	Subject common name. Example: ssl902285.cloudflaressl.com. `string`
subject_email	`eq`, `contains`, `exists`, `not_exists`	Subject email. `string`
fingerprint_md5	`eq`	MD5 fingerprint. Enter a hexadecimal string without spaces in lowercase. Example: `500d1a99a670675a2e0b147b31ea17ce`. `string`
fingerprint_sha1	`eq`	SHA1 fingerprint. Enter a hexadecimal string without spaces in lowercase. Example: `f817a45f860581ff9911ce6405d3e194e90a0f3f`. `string`
fingerprint_sha256	`eq`	SHA256 fingerprint. Enter a hexadecimal string without spaces in lowercase. Example: `f239e183459c727c7b2694937f04e5925ffaf969a10cc31ce848fdd0ccf6e40f`. `string`
validity_start	`eq`, `gte`, `lte`	Certificate validity start date. Format: `YYYY-MM-DD`. `string`
validity_end	`eq`, `gte`, `lte`	Certificate validity end date. Format: `YYYY-MM-DD`. `string`
is_trusted	`eq`	Find certificates that have been verified and validated by Spyse. `bool`

Body Params

column_list

array of strings

required

List of columns to download. Supported values: fingerprint_sha256, validity_status, issuer_dn, validity_start, validity_end, updated_at, subject_dn, organization, location, issuer_country, issuer_organization, issuer_common_name, issuer_email, subject_country, subject_organization, subject_common_name, subject_email, fingerprint_md5, fingerprint_sha1, subject_alternative_names

column_list*

description

string

length ≤ 254

An optional field with a short file description. Max length: 254 characters.

file_format

string

required

The file format to use for the file creation. Supported values: ndjson, csv.

rows_count

int64

≥ 1

The number of rows the user wants to receive in the current download request.

search_params

array of objects

required

A list of certificate attributes to filter the search results by. A comprehensive list of valid search parameters is shown in the table below.

search_params*

Responses

200Operation successful

400Bad request

401Unauthorized

500Internal server error