Urgent alerts

#Critical advisories, newly exploited CVEs and people's own alerts, with where each device in scope stands: affected / possibly / patched / safe

Address

https://<your-org>.brambleit.cloud/warden/api/alerts

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Warden.

Response 200

{
  "alerts": [],
  "feeds": []
}

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/warden/api/alerts', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Public notices (lib/notices.js): everything NCSC / CERT-EU published about vulnerabilities, with the alert each one raised or joined

Address

https://<your-org>.brambleit.cloud/warden/api/notices

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Warden.

Response 200

{
  "notices": []
}

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/warden/api/notices', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Get an alert with affected devices

Address

https://<your-org>.brambleit.cloud/warden/api/alerts/:id

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Warden.

Path parameters

Query parameters

Response 200

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/warden/api/alerts/12.5', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Reads a pasted link (NCSC / vendor notice) for the "Track an alert" form: its title, summary, CVE IDs and the distro advisories that cover them

Address

https://<your-org>.brambleit.cloud/warden/api/alerts/lookup

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Warden.

Request body JSON

Response 200

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/warden/api/alerts/lookup', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"url":"https://example.com/…"}),
});
const data = await res.json();

#Add an alert by hand

Address

https://<your-org>.brambleit.cloud/warden/api/alerts

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Warden.

Request body JSON

Response 201

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/warden/api/alerts', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"force":"…","title":"Example title"}),
});
const data = await res.json();

#Update an alert

Address

https://<your-org>.brambleit.cloud/warden/api/alerts/:id

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Warden.

Path parameters

Response 200

{
  "ok": true
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/warden/api/alerts/12.5', {
  method: 'PUT',
  credentials: 'include',
});
const data = await res.json();

#Delete an alert

Address

https://<your-org>.brambleit.cloud/warden/api/alerts/:id

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Warden.

Path parameters

Response 200

{
  "ok": true
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/warden/api/alerts/12.5', {
  method: 'DELETE',
  credentials: 'include',
});
const data = await res.json();

#Archive or restore an alert

Address

https://<your-org>.brambleit.cloud/warden/api/alerts/:id/dismiss

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Warden.

Path parameters

Request body JSON

Response 200

{
  "ok": true
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/warden/api/alerts/12.5/dismiss', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"restore":"…"}),
});
const data = await res.json();

#Check devices against an alert again

Address

https://<your-org>.brambleit.cloud/warden/api/alerts/:id/recheck

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Warden.

Path parameters

Response 202

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/warden/api/alerts/12.5/recheck', {
  method: 'POST',
  credentials: 'include',
});
const data = await res.json();

#A container image on one device: accept this alert's findings in it until a newer image is out ({ device_id, image_id, undo })

Address

https://<your-org>.brambleit.cloud/warden/api/alerts/:id/containers/accept

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Warden.

Path parameters

Request body JSON

Response 200

{
  "ok": true,
  "findings": 1
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/warden/api/alerts/12.5/containers/accept', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"device_id":7,"image_id":7,"undo":"…"}),
});
const data = await res.json();