v1inquiries

Returns a list of all inquiries

Query parameters
exclude_attributes
array[string]
List of attributes to exclude
include_attributes
array[string]
List of attributes to include
limit
integer
Number of inquiries to get
Responses

List of inquries

array[object]
id
string
ID of this inquiry
required
schema
object
JSON schema used to validate repsonse(s)
required
roles
array[string]
List of RBAC roles permitted to respond to this inquiry
required
users
array[string]
List of users permitted to respond to this inquiry
required
route
string
An arbitrary value for allowing rules to route to proper notification channel
required
ttl
integer
Time (in minutes) that an unacknowledged Inquiry is cleaned up
required

Get a specific Inquiry based on ID.

Path parameters
inquiry_id
string
Inquiry ID
required
Responses

Inquiry requested.

object
id
string
ID of this inquiry
required
schema
object
JSON schema used to validate repsonse(s)
required
roles
array[string]
List of RBAC roles permitted to respond to this inquiry
required
users
array[string]
List of users permitted to respond to this inquiry
required
route
string
An arbitrary value for allowing rules to route to proper notification channel
required
ttl
integer
Time (in minutes) that an unacknowledged Inquiry is cleaned up
required

Respond to an Inquiry.

Path parameters
inquiry_id
string
Inquiry ID
required
Request body

Inquiry response

object
id
string
Inquiry ID
required
response
object
response data
required
Responses

Response received

object
id
string
Inquiry ID
required
response
object
response data
required