post https://sandbox1-api.unit21.com/v1/sars/list
Returns paginated list of of top-level information about paths/[email protected]
Because the response is paginated, the request body has a limit
and offset
field. At least one must be filled.
limit
indicates how many objects the request returns (the page maximum is 50)offset
indicates the offset for pagination. Anoffset
value of 1 starts with the environment's first record. The offset is relative to the number of pages (not the total count of objects).
To narrow down your sars search, we provide filter parameters to this endpoint. Note that all list inputs function as an "or" filter, as in any one of the values must match the selected sar(s):
Field | Type | Description |
---|---|---|
created_after | Numeric | SARs created on or after this unix timestamp |
created_before | Numeric | SARs created before this unix timestamp |
tag_filters | String[] | List of string tags (key:value ) or keys to associate this SARs with (e.g. sars_type:high_velocity or sars_type ). If only the key is provided, we will match against all tags with that key |
limit | Numeric | A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10 |
offset | Numeric | The offset for pagination. Default is 1 |
options | Object | Options for the data included in the returned SARs. Removing unneeded options can improve response speed |
The total_count
field contains the total number of sars where the response_count
field contains the number of sars included in the response.
Follow the links for more information: