censys_export_job_status {censys}R Documentation

Get status of a Censys export job

Description

The Get Job Status endpoint lets you retrieved information about a previously submitted job. The status field will return "pending" until the job has completed at which time status will be "success" or "error". On success, the output will define download_paths, a list of files that can be downloaded for the next 24 hours. After 24 hour, the job status will change to "expired" and the files will no longer be retrievable.

Usage

censys_export_job_status(job_id)

Arguments

job_id

Censys export job id (from calling censys_start_export())

Details

You must have both CENSYS_API_ID and CENSYS_API_SECRET present in the R environment for the functions in this package to work. It is highly suggested that you place those in ~/.Renviron at least for interactive work.

Value

API call result (invisibly)

References

Censys SQL query syntax: https://censys.io/query; API doc: https://censys.io/api/v1/docs/export

Examples

## Not run: 
q <- censys_start_export("
SELECT location.country, count(ip) FROM ipv4.20161206 GROUP BY location.country
")
censys_export_job_status(q$job_id)
censys_export_download(q$job_id, "~/Data")

## End(Not run)

[Package censys version 0.1.0 Index]