Search Policies

Search through Policies based on provided filters

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Searches policies with column filters and free-text terms, sorts the results by id, name, status, created_at, updated_at, or last_evaluation in ascending or descending order, and returns a paged list. Set only_archived to true to search archived policies only.

When to use it

Use it to combine several search terms, filter on specific columns, or control the sort order of the results.

Required parameters

This call takes no required parameters.

Optional body fields: filters, search, sort_by, sort_direction, only_archived. Use page and size to page through the results.

Response

A successful call returns 200 OK with a page of PolicyResponse objects in items, plus the paging fields total, page, size, and pages.

Related: List policies, Get a policy, List policies with a tag

Query Params
integer
≥ 1
Defaults to 1

Page number

integer
≤ 1000
Defaults to 25
Body Params
array | null

Filter on db columns

Free text search on searchable fields

string
enum
Defaults to updated_at

Field to sort by

Allowed:
string
enum
Defaults to desc

Sort direction (ascending or descending)

Allowed:
boolean
Defaults to false
Responses

404

Not Found

500

Internal Server Error

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json