Get Filter Suggestions

POST 
/audit/api/v1/filter/suggest

Get UI Filter Suggestions for Resource Types and User

Rate Limits

The following rate limits apply:

• Request rate limit: 10/sec
• Burst limit: 10/sec

Request

application/json

Body

required

filterName stringrequired

The name of the filter

query string

Case-insensitive query to suggest filter values. Includes only items that contain the query as a substring.

Responses

200

Successful Operation

application/json

Schema

Schema

suggestions string[]

List of Suggestions

queryRemainder string

Query Remainder

Example (from schema)

{
  "suggestions": [
    "string"
  ],
  "queryRemainder": "string"
}

400

Bad Request

application/json

Schema

Schema

error object

The actual error object

code stringrequired

Error Codes: BadRequest(400), Unauthorized(401), Forbidden(403), TooManyRequests(429).

message stringrequired

A human-readable representation of the error.

target string

The target of the error

details undefined[]

An array of details about specific errors that led to this reported error

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      null
    ]
  }
}

401

Unauthorized

application/json

Schema

Schema

error object

The actual error object

code stringrequired

Error Codes: BadRequest(400), Unauthorized(401), Forbidden(403), TooManyRequests(429).

message stringrequired

A human-readable representation of the error.

target string

The target of the error

details undefined[]

An array of details about specific errors that led to this reported error

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      null
    ]
  }
}

403

Forbidden

application/json

Schema

Schema

error object

The actual error object

code stringrequired

Error Codes: BadRequest(400), Unauthorized(401), Forbidden(403), TooManyRequests(429).

message stringrequired

A human-readable representation of the error.

target string

The target of the error

details undefined[]

An array of details about specific errors that led to this reported error

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      null
    ]
  }
}

429

Too Many Requests

application/json

Schema

Schema

error object

The actual error object

code stringrequired

Error Codes: BadRequest(400), Unauthorized(401), Forbidden(403), TooManyRequests(429).

message stringrequired

A human-readable representation of the error.

target string

The target of the error

details undefined[]

An array of details about specific errors that led to this reported error

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      null
    ]
  }
}

Loading...