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; the version on npm is 0.12.0. Every example on this page is compiled against the installed package when these docs build: a call that does not type-check 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

GET/v1/audit-events

Browse the audit chain

const  = await ..("/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  = 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

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/health

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

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

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
  }
});
// 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.

Audit Events | CodeSpar