Audit Events
The 10 operations under audit-events, as typed calls on the generated REST client.
Available from @codespar/sdk 0.12.0; the version on npm is 0.16.18. When these docs build, the examples on this page are compiled against @codespar/sdk 0.16.18, the version this site installs: a call that does not type-check against it fails the build.
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 { } from "@codespar/sdk";
const = new ({ : .. });GET /v1/audit-events
Browse the audit chain
const = await ..("get", "/v1/audit-events");
// 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 (.) {
.(.);
}Parameters, body and every documented response: GET /v1/audit-events in the HTTP reference.
GET /v1/audit-events/anchors
List audit-chain anchors
const = await ..("/v1/audit-events/anchors");Parameters, body and every documented response: GET /v1/audit-events/anchors in the HTTP reference.
POST /v1/audit-events/anchors/verify
Verify an anchor document against our record
const = await ..("post", "/v1/audit-events/anchors/verify", {
: {
: 1,
: "anchor_0000000000000000",
: "org_0000000000000000",
: 0,
: "string",
: "2026-01-15T12:00:00.000Z",
: "HMAC-SHA256",
: "string"
}
});
// 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 (.) {
.(.);
}Parameters, body and every documented response: POST /v1/audit-events/anchors/verify in the HTTP reference.
GET /v1/audit-events/config
Read the chain verification thresholds
const = await ..("/v1/audit-events/config");Parameters, body and every documented response: GET /v1/audit-events/config in the HTTP reference.
PATCH /v1/audit-events/config
Change the chain verification thresholds
const = await ..("patch", "/v1/audit-events/config", {
: {
"x-codespar-user": "string"
},
: {
: 0,
: 0,
: 1,
: 0,
: 1,
: 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 (.) {
.(.);
}Parameters, body and every documented response: PATCH /v1/audit-events/config in the HTTP reference.
GET /v1/audit-events/export
Export audit events, with a signed manifest
const = await ..("get", "/v1/audit-events/export", {
: {
: "string",
: "string"
}
});
// 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 (.) {
.(.);
}Parameters, body and every documented response: GET /v1/audit-events/export in the HTTP reference.
GET /v1/audit-events/health
What the verifier says about this chain
const = await ..("/v1/audit-events/health");Parameters, body and every documented response: GET /v1/audit-events/health in the HTTP reference.
GET /v1/audit-events/incidents
List chain-integrity incidents
const = await ..("/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
Acknowledge a chain-integrity incident
const = await ..("post", "/v1/audit-events/incidents/{id}/acknowledge", {
: {
: "incident_0000000000000000"
},
: {
"x-codespar-user": "string"
},
: {
: "string",
: "not_required",
: true,
: "string",
: 0,
: 0
}
});
// 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 (.) {
.(.);
}Parameters, body and every documented response: POST /v1/audit-events/incidents/{id}/acknowledge in the HTTP reference.
POST /v1/audit-events/verify
Verify the chain over an interval
const = await ..("post", "/v1/audit-events/verify", {
: {
: "string",
: "string"
}
});
// r.status is one of the documented statuses (200, 422),
// each with its own body shape in r.data; nothing here throws on 422.
if (.) {
.(.);
}Parameters, body and every documented response: POST /v1/audit-events/verify in the HTTP reference.