Skip to main content
REST client

Audit Events

The 6 operations under audit-events, as typed calls on the generated REST client.

1 min read
View MarkdownEdit on GitHub

Audit Events

Available from @codespar/sdk 0.12.0, which is not on npm yet. The published version today is 0.11.0, and it has no cs.api; 0.12.0 is on the main branch of codespar-core. The examples below are not compiled against the installed package for that reason.

Every call below is cs.api reaching one operation of the OpenAPI document this page was generated from; the REST client overview explains request, response, the option bag and the errors. The values are placeholders shaped by the document.

import { CodeSpar } from "@codespar/sdk";

const cs = new CodeSpar({ apiKey: process.env.CODESPAR_API_KEY });

GET /v1/audit-events

GET/v1/audit-events

Browse the audit chain

const result = await cs.api.get("/v1/audit-events");

Parameters, body and every documented response: GET /v1/audit-events in the HTTP reference.

GET /v1/audit-events/config

GET/v1/audit-events/config

Read the chain verification thresholds

const result = await cs.api.get("/v1/audit-events/config");

Parameters, body and every documented response: GET /v1/audit-events/config in the HTTP reference.

PATCH /v1/audit-events/config

PATCH/v1/audit-events/config

Change the chain verification thresholds

const r = await cs.api.response("patch", "/v1/audit-events/config", {
  header: {
    "x-codespar-user": "string"
  },
  body: {
    verification_window_days: 0,
    hot_window_days: 0,
    hot_max_staleness_seconds: 1,
    warm_window_days: 0,
    warm_max_staleness_seconds: 1,
    cold_max_staleness_seconds: 1
  }
});
// r.status is one of the documented statuses (200, 403),
// each with its own body shape in r.data; nothing here throws on 403.
if (r.ok) {
  console.log(r.data);
}

Parameters, body and every documented response: PATCH /v1/audit-events/config in the HTTP reference.

GET /v1/audit-events/health

GET/v1/audit-events/health

What the verifier says about this chain

const result = await cs.api.get("/v1/audit-events/health");

Parameters, body and every documented response: GET /v1/audit-events/health in the HTTP reference.

GET /v1/audit-events/incidents

GET/v1/audit-events/incidents

List chain-integrity incidents

const result = await cs.api.get("/v1/audit-events/incidents");

Parameters, body and every documented response: GET /v1/audit-events/incidents in the HTTP reference.

POST /v1/audit-events/incidents/{id}/acknowledge

POST/v1/audit-events/incidents/{id}/acknowledge

Acknowledge a chain-integrity incident

const r = await cs.api.response("post", "/v1/audit-events/incidents/{id}/acknowledge", {
  path: {
    id: "incident_0000000000000000"
  },
  header: {
    "x-codespar-user": "string"
  },
  body: {
    resolution_summary: "string",
    anpd_notification_status: "not_required",
    personal_data_affected: true
  }
});
// r.status is one of the documented statuses (200, 403),
// each with its own body shape in r.data; nothing here throws on 403.
if (r.ok) {
  console.log(r.data);
}

Parameters, body and every documented response: POST /v1/audit-events/incidents/{id}/acknowledge in the HTTP reference.

Audit Events | CodeSpar