Skip to content
KataraKatara documentation

Read the sealed rows of a snapshot

GET
/katara/v1/orgs/{org_id}/environments/{environment_id}/audit/exports/{id}/records
curl --request GET \
  --url 'https://api.katara.com/katara/v1/orgs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/environments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/audit/exports/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/records?limit=100' \
  --cookie katara_session=<katara_session>

Reads a sealed snapshot back, manifest first and then its rows in the order they were sealed. Each row carries the digest it was sealed with, and the manifest digest covers the header and every row digest in order, so a holder can check a copy against the system it came from. A row that no longer matches its seal is refused rather than served.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
environment_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000

Query Parameters

Section titled “Query Parameters”
after
integer
<= 10000
limit
integer
default: 100 >= 1 <= 100

Responses

Section titled “Responses”

200

Section titled “200”

A page of sealed rows with the manifest they belong to.

Media typeapplication/json
object
manifest
required
object
schema_version
required
Allowed value: 1
org_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
environment_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
mode
required
Allowed values: test live
reset_generation
required
integer
>= 1 <= 9007199254740991
before_time
required
string format: date-time
created_at
required
string format: date-time
expires_at
required
string format: date-time
record_count
required
integer
>= 1 <= 10000
integrity
required
string
/^sha256:[a-f0-9]{64}$/
data
required
Array<object>
<= 100 items
object
ordinal
required
integer
>= 1 <= 10000
entry
required
object
id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
actor_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
operation
required

The recorded operation. repositories.versions.approve is Katara approving a document version it read from an attached repository; actor_id is then the person whose attaching or renewing gave the approval it acted under. The github.installations operations are the organization’s and github.login operations a member’s own; they appear in every environment of the organization with its current reset generation.

string
Allowed values: agent_subjects.create agent_subjects.change agents.publish agents.revoke approvals.decide budgets.fund budgets.close collections.create collections.rename collections.delete content.connections.prepare content.connections.verify content.connections.revoke content.stores.create content.stores.revoke content.uploads.begin content.uploads.complete content.access.change content.objects.delete content.versions.approve evaluations.create evaluations.dataset.publish evaluations.dataset.revoke evaluations.rubric.publish evaluations.rubric.revoke evaluations.rubric.review grants.issue grants.delegate grants.revoke keys.create payer_consents.create payer_consents.revoke policies.publish policies.review policies.activate policies.revoke runs.create runs.cancel tools.publish tools.revoke tools.set_enabled traces.export environments.reset agents.rollback.review agents.rollback.activate credentials.connect credentials.reconnect credentials.revoke credentials.oauth.begin credentials.oauth.activate event_sources.publish event_sources.activate event_sources.retire federation.self.begin federation.provision.approve schedules.publish schedules.activate schedules.retire evaluations.thresholds.record evaluations.online.set audit.export runs.reconcile holds.place holds.release actions.reconcile repositories.attach repositories.detach repositories.renew repositories.sync repositories.versions.approve github.installations.link github.installations.unlink github.login.link github.login.unlink
resource_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
reset_generation
required
integer
>= 1 <= 9007199254740991
created_at
required
string format: date-time
integrity
required
string
/^sha256:[a-f0-9]{64}$/
next_cursor
integer
>= 1 <= 10000
Example
{
  "manifest": {
    "schema_version": 1,
    "mode": "test"
  },
  "data": [
    {
      "entry": {
        "operation": "agent_subjects.create"
      }
    }
  ]
}

default

Section titled “default”

Request rejected or unavailable.

Media typeapplication/json
object
error
required
object
message
required
string
>= 1 characters <= 500 characters
type
required
string
>= 1 characters <= 100 characters
code
required

Stable; branch on it. Any operation can answer invalid_request, with param naming the refused field when there is one; human_session_required, when an API key, service account or workload calls an operation only a signed-in person may perform; reauthentication_required, when a person’s sign-in is too old for the operation; permission_denied; route_not_found and method_not_allowed, when no operation matches the path or method; and feature_unavailable, when the operation’s service is not enabled on this deployment.

string
>= 1 characters <= 100 characters
param
required

The request field a refusal is about, such as the agent_id or run_id query parameter; null when the refusal is not about one field.

string | null
request_id
required
string
>= 1 characters <= 100 characters
upstream_status
required
integer | null
action
Allowed values: sign_in reauthenticate request_access review fund retry reconcile refresh support
operation_id
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
snapshot_ref
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
Example
{
  "error": {
    "action": "sign_in"
  }
}