radar
List Radar alerts by status.
List Radar alerts by status.
OpenAPI specificationPOST
/api/v1/radar/alerts-listAuthentication
bearerAuth
Request
curl --globoff --request POST \
--url 'https://honen.com/api/v1/radar/alerts-list' \
--header 'Authorization: Bearer <BEARER_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{}'Replace credential and <field> placeholders with your own values. URL placeholders appear as %3Cfield%3E. Review the example values before sending your request.
Use the sample JSON body as your starting point, and enter values that match the endpoint's schema.
Request body schema or example
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"new",
"dismissed",
"actioned",
"partially_actioned",
"all"
]
},
"limit": {
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true
}
}
}Responses
200Command result.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
true
]
},
"data": {
"type": "object",
"properties": {
"alerts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"monitorId": {
"type": "string"
},
"monitorName": {
"type": "string"
},
"monitorTags": {
"type": "array",
"items": {
"type": "string"
}
},
"monitorAttachedCourseIds": {
"type": "array",
"items": {
"type": "string"
}
},
"tailoredTitle": {
"type": "string"
},
"tailoredSummary": {
"type": "string"
},
"recommendations": {
"description": "Arbitrary JSON value."
},
"status": {
"type": "string"
},
"detectedAt": {
"type": "string"
},
"actionedActions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"mode": {
"type": "string",
"enum": [
"create",
"append"
]
},
"courseId": {
"type": "string",
"nullable": true
},
"courseTitle": {
"type": "string",
"nullable": true
},
"status": {
"type": "string"
}
},
"required": [
"id",
"mode",
"courseId",
"courseTitle",
"status"
]
}
}
},
"required": [
"id",
"monitorId",
"monitorName",
"monitorTags",
"monitorAttachedCourseIds",
"tailoredTitle",
"tailoredSummary",
"recommendations",
"status",
"detectedAt",
"actionedActions"
]
}
}
},
"required": [
"alerts"
]
}
},
"required": [
"success",
"data"
]
}400Malformed JSON request body.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}401Missing or invalid Connector credentials.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}403Connector policy does not permit this command.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}404Unknown command.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}422Input validation error.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}