Skip to main content
POST
Log activity

Authorizations

Authorization
string
header
required

Environment AUTH_KEY. Full ledger access and primary API-key administration. Not OAuth or JWT.

Headers

Idempotency-Key
string
required
Required string length: 1 - 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]*$

Body

application/json
occurred_on
string<date>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
provenance
object
required
data
object
required
attachment_ids
string<uuid>[]
Maximum array length: 20
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
occurred_at
string<date-time> | null
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
ended_at
string<date-time> | null
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
timezone
string
Required string length: 1 - 100
time_precision
enum<string>
Available options:
date,
instant,
period,
unknown
date_basis
enum<string>
Available options:
reported_date,
event_date,
wake_date,
specimen_date,
report_date,
unknown
validity
enum<string>
Available options:
valid,
suspect,
invalid

Response

Committed mutation or durable idempotent replay

catalog_version
string
required
Allowed value: "1.0.4"
record
object
required
warnings
string[]
required
Required string length: 1 - 200
idempotent_replay
boolean
required
committed_version
integer
required
Required range: x <= 9007199254740991