LOlocalfalcon
Falcon Guard

List of All Falcon Guard Reports

Allows you to retrieve the full list of all Falcon Guard Reports within your Local Falcon account.

If more records exist than is allowed within the set limit, a value will be returned under next_token that can be used as a parameter to request the next page of results.

post/v1/guard/

Request

  • Base URL
    https://api.localfalcon.com
  • Auth
    none declared

Request body application/x-www-form-urlencoded

api_keystring required

Your Local Falcon API key.

start_datestring

A lower limit date you wish to retrieve. Expects date formatted as MM/DD/YYYY.

end_datestring

Upper limit date you wish to retrieve. Expects date formatted as MM/DD/YYYY.

status'protected' | 'paused'

Filter results based on location's protection status.

limitinteger

The number of results you wish to retrieve.

next_tokenstring

This parameter is used to get the next 'page' of results. The value used with the parameter is provided from a previous response by this endpoint if more 'pages' of results exist.

Response

Successful response

codeinteger
code_descboolean
successboolean
messageboolean
parametersobject

Changes

No recorded changes to this operation across all 5 revisions of this API.