Retrieves all Guidance Recommendations

get

https://{serverURL}/api/guidance

Retrieves all guidance recommendations.

Query Params

max

int64

Defaults to 25

Maximum number of records to return

offset

int64

Defaults to 0

Offset records, the number of records to skip, for paginating requests

sort

string

Defaults to name

Sort order, the name of the property to sort by

direction

string

enum

Defaults to asc

Sort direction, use 'desc' to reverse sort

Allowed:

phrase

string

Search phrase for partial matches on name or description

severity

string

enum

Filter by severity

Allowed:

type

string

enum

Filter by Guidance Type. See Retrieves Guidance Types for most up to date list of types.

Allowed:

state

string

enum

Filter by state, restricts query to only load discoveries by state

Allowed:

Responses

Language

Credentials

Bearer

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Request

4XXError Codes

5XXError Codes