Using the REST API v2 dataexport Iterator Endpoints

The Netskope dataexport endpoints, also called iterator endpoints, provide a simplified way of consuming tenant log information. This article describes the best practices for consumption of this data. Netskope recommends leveraging existing clients for SIEM integration where possible through the use of the following solutions:

If the aforementioned clients are insufficient, Netskope also provides a python SDK.

Through the use of an index, the Netskope platform tracks log consumption though a simplified operational workflow that replicates that often seen in web forums. When a consumer requests a page of data from the endpoint, Netskope delivers the requested data by writing an index as to the data provided. When the consumer has completed processing the requested page of data, the consumer simply requests the next page of data.

Each endpoint stores its own index value, which is provided by the consumer on query. This allows for easy parallelization of API calls across multiple endpoints concurrently.

The endpoint query structure is very easy to construct.

https://<tenant-URL>/api/v2/<endpoint>/?operation=<operation>&index=<index>

The epoch timestamp and next operations both update the Netskope stored index, where the resend operation asks for the prior page without updating the index.

The index value for the iterator is a string value supplied by the consumer that is used by Netskope to store the page values. This index should be unique by the consumer to prevent data consumption challenges. The consumer may use the same index value across multiple endpoints without concern.

The index string is used for when more than one system is pulling logs. For example, you are using ​demo​ as the index and pull records 1-1000. The next time ​demo​​ pulls logs, it will pull logs 1001-2000 (if pulling 1000 at a time).

If you leave it blank and have two systems pulling logs, the first system will pull logs 1-1000, and then when the second system pulled logs, it will get 1001-2000. This is not optimal.

If you have system1 (demo1) and system2 (demo2) pulling logs at the same time, each will get 1-1000 if using unique index strings.

Not using an index has the chance of “being reused”. If you define your own index, you can guarantee that only you have that index value and won’t lose records.

Netskope Iterator endpoints deliver 10,000 record pages per API call.

Each iterator query will provide guidance in seconds how long to wait. This value is calculated based on the amount of data returned in your API call.

{
    "ok": 1,
    "result": [
        {
        }
    ],
    "wait_time": 5

Using the response headers to manage rate limits to avoid 429 error messages is recommended.

HTTP/1.1 200 OK
....
RateLimit-Limit: 4
RateLimit-Remaining: 1
RateLimit-Reset: 1
...

 

If a Rate is exceeded, the headers will be extended, and the data payload will mention why the query returned a 429 error response.

HTTP/1.1 429 Too Many Requests
...
RateLimit-Remaining: 0
RateLimit-Reset: 1
Retry-After: 1
RateLimit-Limit: 4
...
{
  "message":"API rate limit exceeded"
}

Example of workflow using the iterator endpoint starting with the oldest record Netskope has.