# Register a new version of an action's audit event schema

<div class="api-op" data-api-operation>
<div class="api-op__main">

<p class="api-endpoint"><span class="method method-post">POST</span> <code>/v1/audit_log_schemas</code></p>

Audit Logs product. Every event of an action is validated against a schema registered for that action (the version the event names, or the latest). A schema lists the target types an event may name and JSON Schemas (a bounded subset of draft 2020-12; other keywords answer parameter_invalid) for the actor's, each target type's and the event's metadata. Registering again creates the next version; versions are never edited. At most 500 actions per environment.

<dl class="api-facts"><div><dt>Scope</dt><dd><code>audit_log_events:write</code></dd></div><div><dt>Auth</dt><dd>Secret key (<code>sk_…</code>)</dd></div><div><dt>Since</dt><dd>1.1</dd></div></dl>

## Headers

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">OhAuthCat-Version</code> <span class="api-field__type">string</span></p>
Minor version; defaults to the environment's pin.
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">Idempotency-Key</code> <span class="api-field__type">string</span></p>
Honoured for 24 h; a replay returns the original response.

<p class="api-field__chips">min length 1 · max length 255</p>
</li>
</ul>

## Request body

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">action</code> <span class="api-field__type">string</span> <span class="api-field__required">Required</span></p>
Lowercase dotted words, e.g. `user.signed_in`.

<p class="api-field__chips">max length 128</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">actor</code> <span class="api-field__type">AuditLogSchemaActor</span></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">targets</code> <span class="api-field__type">array of AuditLogSchemaTarget</span> <span class="api-field__required">Required</span></p>

<p class="api-field__chips">min items 1 · max items 50</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">metadata</code> <span class="api-field__type">AuditLogJSONSchema</span></p>
A JSON Schema of the supported subset (type, properties, required, additionalProperties as a boolean, enum, const, minLength, maxLength, pattern, minimum, maximum, items, minItems, maxItems, $schema, title, description).
</li>
</ul>

## Responses

<ul class="api-responses">
<li class="api-response"><span class="api-status api-status--ok">201</span> <span>The new schema version. <span class="api-field__type">AuditLogSchema</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">400</span> <span>Invalid request. Codes: <a href="/errors/parameter_invalid/">parameter_invalid</a>, <a href="/errors/parameter_missing/">parameter_missing</a>, <a href="/errors/version_unsupported/">version_unsupported</a> and resource-specific codes from the catalogue. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">401</span> <span>Codes: <a href="/errors/authentication_required/">authentication_required</a>, <a href="/errors/api_key_invalid/">api_key_invalid</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">403</span> <span>Codes: <a href="/errors/api_key_scope_missing/">api_key_scope_missing</a>, <a href="/errors/ip_not_allowed/">ip_not_allowed</a>, <a href="/errors/plan_limit_reached/">plan_limit_reached</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">429</span> <span>Code: <a href="/errors/rate_limited/">rate_limited</a>. Retry-After is set. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">503</span> <span>Code: <a href="/errors/service_unavailable/">service_unavailable</a>. Retry-After is set; writes are paused. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--neutral">default</span> <span>Any other error, including <a href="/errors/internal_error/">internal_error</a>. Every code is in the error catalogue. <span class="api-field__type">Error</span></span></li>
</ul>

Errors share one shape; see the [error code catalogue](/errors/).

</div>
<div class="api-op__code">

**curl**

```sh wrap
curl -X POST \
  "https://api.ohauthcat.com/v1/audit_log_schemas" \
  -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "user.signed_in",
  "targets": [
    {
      "type": "default",
      "metadata": {
        "plan": "enterprise"
      }
    }
  ]
}'
```

**Node**

```javascript wrap
const response = await fetch("https://api.ohauthcat.com/v1/audit_log_schemas", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    action: "user.signed_in",
    targets: [
      {
        type: "default",
        metadata: {
          plan: "enterprise",
        },
      },
    ],
  }),
});
const data = await response.json();
```

**Python**

```python wrap
import os
import requests

response = requests.post(
    "https://api.ohauthcat.com/v1/audit_log_schemas",
    headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},
    json={
        "action": "user.signed_in",
        "targets": [
            {
                "type": "default",
                "metadata": {
                    "plan": "enterprise",
                },
            },
        ],
    },
)
data = response.json()
```

```json title="Response 201" wrap
{
  "object": "audit_log_schema",
  "action": "user.signed_in",
  "version": 1,
  "actor": {
    "metadata": {
      "plan": "enterprise"
    }
  },
  "targets": [
    {
      "type": "default",
      "metadata": {
        "plan": "enterprise"
      }
    }
  ],
  "metadata": {
    "plan": "enterprise"
  },
  "created_at": "2026-01-15T09:30:00Z"
}
```

</div>
</div>
