API Reference
Security Interview Platform API documentation
Base URL: https://security-interview.vercel.app
Authorization: GET FROM INTERVIEWER
GET /api/alerts
Response:
["alert:uuid-uuid-uuid-uuid", "alert:uuid-uuid-uuid-uuid"]GET /api/alerts?uuid={}
Response:
{
"uuid": "uuid-uuid-uuid-uuid",
"title": "Alert title",
"opened": 1709013600000,
"closed": 1709017200000,
"annotations": [
{
"body": "Annotation text",
"author": "Author name",
"timestamp": 1709013600000
}
],
"body": "Alert body",
"resolution_note": "Resolution note"
}POST /api/webhook
Create a new alert
Creates a new alert and returns the UUID.
Request:
{
"title": "Alert title",
"body": "Alert body"
}Response:
{
"string": "UUID: uuid-uuid-uuid-uuid"
}Close an alert
Closes an alert with a resolution note.
Request:
{
"uuid": "uuid-uuid-uuid-uuid",
"resolution_note": "Resolution note"
}Response:
{
"string": "UUID uuid-uuid-uuid-uuid closed"
}POST /api/annotate
Add a message to the annotations on the alert.
Request:
{
"uuid": "uuid-uuid-uuid-uuid",
"annotation": {
"body": "Annotation text",
"author": "Author name",
"timestamp": 1709013600000
}
}Response:
{
"string": "alert uuid-uuid-uuid-uuid now has 10 items"
}