Getting Started
🚀 Clone Systems Scan API Documentation
The Clone Systems Security Scanning Application Programmers Interface (API) allows third parties to integrate their own
applications with Clone Systems security scanning solution.
The API functions detailed in this programming reference are available
to customers that subscribe to Clone Guard® Security Scanning services.
Getting Started
The following sections give you an introduction to the Clone Systems Security Scanning API and show you how to make requests
using the API.
Available Products
Filtering Data
This API provides a flexible and powerful way to filter and retrieve data from your resources. Whether you need to search for specific records, narrow down results by date, sort the data, or paginate through the results, we have you covered with a variety of filtering options.
Search By
- Parameter:
q[column]
- Description: Use the q parameter to perform searches based on specific columns within your dataset. Simply specify the column you want to search and provide a search value.
- Example: To search for records with a name containing 'test', use
q[name]='test*'
. To search for records with hosts in the range'192.168.'
, useq[hosts]='192.168.*'
.
Date Ranges
Simple Date Range
- Parameters:
date_range_start
,date_range_end
- Description: Filter records by specifying a specific date range. Use
date_range_start
to set the start date anddate_range_end
to set the end date, both in the formatYYYY-MM-DD hh:mm:ss
.
Relative Date Range
- Parameter:
relative_date_range
- Description: Filter records based on a relative date range. Choose from a variety of time units, including
seconds (s)
,minutes (m)
,hours (h)
,days (d)
,months (M)
,years (y)
, andquarters (q)
. - Example: To get results for the last 10 days, use
10d
. To retrieve records from the first quarter of 2020, use1q2020
.
Sorted By
- Parameters:
sort_by
- Description: Sort your results based on specific columns and in either ascending (asc) or descending (desc) order.
- Example: To sort by the column_name in ascending order, use
sort_by=column_name_asc
. To sort in descending order, usesort_by=column_name_desc
.
Pagination
- Parameters:
page
,per_page
- Description: Manage the presentation of your results through pagination. Use page to specify the current page number and per_page to set the number of results per page. Max per_page is 100. Default per_page is 10 and page 1.
- Example: To retrieve the second page of results with 20 records per page, use
page=2
andper_page=20
.
:::check[]
With these filtering options, you can tailor your API requests to suit your specific data retrieval needs, making it easy to find and retrieve the information you require efficiently and accurately.
:::